NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
13 stars 10 forks source link

617 - Adding functionality documentation #618

Open evrose54 opened 4 weeks ago

evrose54 commented 4 weeks ago

Reviewer Checklist

Related Issues

fixes NRLMMD-GEOIPS/geoips#617

Testing Instructions

Run ./docs/build_docs . geoips html_only and get an output of 0. Download the build/sphinx/html/ folder, then drag the <html_download_name>/new-docs/index.html file into your browser.

Summary

With the recent merge of docs/new-docs, we are largely updating all of our GeoIPS documentation. This specific branch handles porting over the documentation wrote in devguide/contributors.rst and devguide/git_workflow.rst to new-docs/contribute/adding-functionality/. This was largely a copy-edit update, however there were some minor updates to both contributors.rst and git_workflow.rst that expanded on how to reach out to GeoIPS Members and to check for issues that have been created and/or are already in progress.

This branch updated docs/source/new-docs/index.rst to use a toctree to point towards what documentation has already been wrote, but I'm happy to revert those changes if we prefer an alternate format. This branch also commented out nearly all of devguide/contributors.rst and devguide/git_workflow.rst so the new documentation under new-docs/contribute/adding-functionality didn't conflict with the embedded references set in their documentation. We'll likely remove the devguide documentation once new-docs is complete in its entirety.

modified: docs/source/devguide/contributors.rst
modified: docs/source/devguide/git_workflow.rst
modified: docs/source/new-docs/index.rst
added: docs/source/new-docs/contribute/adding-functionality/contributors.rst
added: docs/source/new-docs/contribute/adding-functionality/git_workflow.rst
deleted: docs/source/new-docs/contribute/adding-functionality/index.rst

Output

Below is an example of the new-docs contributors page. Screenshot 2024-05-28 at 2 06 19 PM

evrose54 commented 4 weeks ago

@biosafetylvl5 please feel free to comment on this PR if you want to see any changes to what's been implemented. I modified the structure of new-docs/index.html to reflect the organizational changes that came alongside #597, however I'm not sure that's exactly how you wanted it done. I was just mimicking what was done with our old documentation. Also, the GitHub workflow Old Docs Have Not Been Changed will fail because I had to comment out the documentation for devguide/contributors.rst and devguide/git_workflow.rst, as their embedded references caused conflicts with the new copy-edited documentation I added to new-docs/contribute/adding-functionality/*.rst. If you would like that reverted, I can just update the references with different names.