This section, under Contributing, will serve as a crossroads document, linking to the Core GeoIPS page and the document for integrating plugins into the official GeoIPS distribution. It will guide users as to where specific types of edits should be performed.
Integrating plugins into the official GeoIPS distribution
Overall conceptual overview of GeoIPS and the architecture
Contact page
Scope of Documentation
Does NOT include
Detailed documentation on specific functionality additions
How to use git/github
Explicit instructions for how to contribute
Does include
Guidance on where to document different types of edits
Checklist for Completion
[x] Work done on a feature branch, eg. documentation-adding-functionality
[x] Write the required documentation in RST.
[x] Add any required resource files to a sub-folder
[ ] Run ./docs/build_docs.sh html_only to ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.
[x] Update the relevant release notes.
[ ] Readable and followable writing, please use a grammar checker + spell checker
[ ] Passes doc8 checks, see the sphinx RST Primer and checkout this black-like tool @biosafetylvl5 wrote for auto-formatting RST files: pink
[ ] A PR from your feature branch to main 😊 with @biosafetylvl5 as a reviewer
Due on for review on: June 3rd
Documentation Task
Core GeoIPSpage and the document forintegrating plugins into the official GeoIPS distribution. It will guide users as to where specific types of edits should be performed.Files to be edited
docs/source/new-docs/contribute/adding-functionality/index.rstResources to be created
Related Documentation
Scope of Documentation
Checklist for Completion
./docs/build_docs.sh html_onlyto ensure the documentation builds correctly, inspect the result, and edit as required to achieve a well formatted document.main😊 with @biosafetylvl5 as a reviewer