[x] NO REQUIRED existing tests (only documentation, and documentation builds. No need for full test)
[x] NO REQUIRED unit tests (Just documentation)
[x] NO REQUIRED integration tests (Just documentation)
[x] Required documentation added for new/modified functionality
[x] Required release notes added for new/modified functionality
[x] NO REQUIRED updates to other repos (Documenting a process, not code)
Related Issues
fixes NRLMMD-GEOIPS/geoips#507
Testing Instructions
Run ./docs/build_docs . geoips html_only. Documentation will build without any errors.
Summary
The aforementioned issue illustrates the need for a guideline which documents why,
when, and how developers should work alongside users and researchers to get their
geospatial data processing routines integrated alongside GeoIPS. Namely, here at CIRA,
this is a large task for GeoIPS developers. We are expected to work alongside
researchers to get their routines integrated alongside GeoIPS, and having this
documentation layed out should streamline this process.
The created guideline illustrates why we do this, what use cases we'll support, and what
information we as developers will need to generate a standalone package containing the
researchers' geospatial data processing routines into a GeoIPS Package.
Reviewer Checklist
Related Issues
fixes NRLMMD-GEOIPS/geoips#507
Testing Instructions
Run
./docs/build_docs . geoips html_only
. Documentation will build without any errors.Summary
The aforementioned issue illustrates the need for a guideline which documents why, when, and how developers should work alongside users and researchers to get their geospatial data processing routines integrated alongside GeoIPS. Namely, here at CIRA, this is a large task for GeoIPS developers. We are expected to work alongside researchers to get their routines integrated alongside GeoIPS, and having this documentation layed out should streamline this process.
The created guideline illustrates why we do this, what use cases we'll support, and what information we as developers will need to generate a standalone package containing the researchers' geospatial data processing routines into a GeoIPS Package.
(Change to v1_12_2a0.rst was needed as the documentation wouldn't build unless there was a blank line after a list)
Output
You can download
geoips/build/sphinx/html
directory and dragindex.html
into your browser to see the new documentation page.