You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Create top-level documentation that provides an overview of the various environmental setups for installing GeoIPS. This includes a high-level description of different installation methods and guidance on which method to choose. The documentation will include section headers for detailed installation guides but will not provide specific installation instructions.
Flow charts or decision trees to help users choose the appropriate installation method (if necessary)
Section headers and layout structure for the installation methods
Related Documentation
Installing GeoIPS
Anaconda Installation
PIP Installation
Expert Installation
Installing for Development
Installing the Docker Image and Using It
Scope of Documentation
Does NOT include
Detailed installation instructions
Step-by-step guides
Does include
High-level descriptions of different installation methods
Guidance on choosing the appropriate installation method
Section headers and layout structure for detailed guides
Checklist for Completion
Work done on a feature branch, eg. documentation-adding-functionality
Write the required documentation in RST.
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.
Update the relevant release notes.
Readable and followable writing, please use a grammar checker + spell checker
Due on for review on: June 3rd
Documentation Task
Files to be edited
Resources to be created
Related Documentation
Scope of Documentation
Checklist for Completion
./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.main
😊 with @biosafetylvl5 as a reviewerThe text was updated successfully, but these errors were encountered: