Documentation: Environmental Setups for GeoIPS Installation

[biosafetylvl5]

Due on for review on: June 3rd

Documentation Task

• 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.

Files to be edited

• docs/source/new-docs/getting-started/installing/index.rst

Resources to be created

• 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
• 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