Skip to content
Snippets Groups Projects
Commit 8e39b908 authored by Paul Tomasula's avatar Paul Tomasula
Browse files

Outline Readme

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.
parent c86e7d66
No related branches found
No related tags found
3 merge requests!96Pygeoapi Reskin,!95Refactor to Consolidated Docker File,!92Ability to provide configuration to prebuilt images
# USGS Pygeoapi Server Build Integration Project
[comment]: <> (This is a collection of hyperlink links in the document for easy edits and readable)
[pygeoapi]: https://github.com/geopython/pygeoapi/tree/master
[pygeoapi configuration]: https://docs.pygeoapi.io/en/latest/configuration.html#
[pygeoapi plugin]: https://docs.pygeoapi.io/en/latest/plugins.html
[set up]: /readmes/SETUP.md
[plugin development]: /readmes/PLUGINS.md
[testing]: /readmes/TESTING.md
This is a complete restructuring of the former project. Rather than a fork of pygeoapi, this is now a separate project that depends on pygeoapi, and then loads our own NLDI plugins in, generating the configuration necessary to accomplish this goal.
# USGS Pygeoapi Server Build Integration
sudo apt -y install python3 python3-pip
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
pip install -U pip
If you are a users for one of the projects houses with this repostiory
#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
For plugin developers, see: [Plugin Developers](/PLUGINS.md)
#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]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment