NISAR Data User Guide

Source for the public documentation of the NASA-ISRO Synthetic Aperture Radar (NISAR) mission hosted at https://nisar-docs.asf.alaska.edu.

Contributing

1. Create a fork of https://github.com/ua-asf/nisar-docs/
2. Clone the repository and navigate to the repository root
3. Create and activate the conda environment

   mamba env create -f environment.yml
   mamba activate nisar-docs
   

4. Run myst start to render the website on your local machine
5. Configure previewing via GitHub Pages (optional)
   1. Enable GitHub Actions for your fork
      screenshot

      
   2. Enable GitHub Pages for your fork with Source = GitHub Actions
      screenshot

      
   3. Create two GitHub Actions variables:
      1. BASE_URL with a value of /nisar-docs (including the leading /)
      2. DOMAIN with a value of https://{github_user_id}.github.io
      screenshot

      
   4. Push changes to your main branch
   5. Preview the rendered site at https://{github_user_id}.github.io/nisar-docs/
6. Make and commit your changes
7. Push changes to your fork in GitHub
8. Make sure your branch is synced and up to date with ua-asf/nisar-docs:main
9. Open a pull request to ua-asf/nisar-docs:main