Skip to content
Snippets Groups Projects
  • Paul Tomasula's avatar
    8e39b908
    Outline Readme · 8e39b908
    Paul Tomasula authored
    Related issue #17
    This adds an outline of missing documentation to components to the main README.md. These TODO items will need to be tackled in separate commits.
    8e39b908
    History
    Outline Readme
    Paul Tomasula authored
    Related issue #17
    This adds an outline of missing documentation to components to the main README.md. These TODO items will need to be tackled in separate commits.

USGS Pygeoapi Server Build Integration

This repository houses USGS's pygeoapi Builder and Integration system. It manages the pygeoapi configuration files and contains the tool to generate USGS specific image for the various projects that depend on pygeoapi. New projects with added functionality can be built on top of the pygeoapi plugin architecture and managed through this repository.

For Users

#TODOs

  • Flesh out to include a link to pygeoapi configuration instruction and documentation
  • Add instructions on how to run an image from the registry using docker compose up
  • Add documentation of environment variables exposed by the images
  • Add documentation of how to configure our customed pygeoapi.config.yml files

For Developers

#TODOs

  • Add primer to set up and update this documenation to reflect current set up instructions
  • Add additional primer on plugin development
  • Add primer for testing