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

Page redirects

Renaming the markdown file for an existing content page in nisar-docs changes the URL for that content, which can result in broken links. Myst does not have a builtin page redirect feature, so we implemented our own solution.

Important

These steps may change in the future, per #93. This section will be updated if a new approach is implemented.

To add a new page redirect, follow the steps below (for example, to redirect page /foo to /bar):

1. Create a new subdirectory in redirects with the same name as the old page, e.g. redirects/foo.
2. Copy the index.html file from one of the existing subdirectories into your new subdirectory, then edit the file to update all occurrences of the redirect URL.
   • For example, copy redirects/product-limitations/index.html to redirects/foo/index.html, then replace all references to /product-known-issues in the new file with /bar.
3. Because the redirect feature depends on some custom build steps in the deploy workflow, you won't be able to test your new redirect locally. You'll need to push to a fork with GitHub Pages enabled (see Contributing) to verify redirect behavior.
4. After the site for your fork has successfully rendered, confirm that /foo redirects to /bar.