update documentation - Githubissues

geopython / pygeoapi

pygeoapi is a Python server implementation of the OGC API suite of standards. The project emerged as part of the next generation OGC API efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is open source and released under an MIT license.

https://pygeoapi.io

MIT License

499 stars 262 forks source link

update documentation #277

Closed tomkralidis closed 4 years ago

tomkralidis commented 5 years ago

Given the awesome work by @jorgejesus to implement project documentation, it's a good time to update docs to provide further user support.

[x] establish table of contents
[x] develop first draft of updates for review and comment/refinement

tomkralidis commented 5 years ago

Suggest ToC for review/comment:

project overview
- features
installation
- pip
- git
- docker
- conda
- UbuntuGIS
- FreeBSD
configuration
administration/publishing
- OpenAPI
running
- wsgi
- asgi
deployment
customization
- plugins
  - overview
  - formatters
  - providers
  - processes
OGC CITE compliance
development
- design/architecture
- testing
- guidelines
Python API documentation
contributing
support
further reading/information
license

jorgejesus commented 5 years ago

The TOC content sounds good

justb4 commented 5 years ago

ToC looks good, possibly need a config reference section/annex, in time with a formal config schema? Or fine in config chapter itself. At least in configuration chapter we should point to more examples, e.g. from unit testing and demo.

justb4 commented 4 years ago

installation: also conda?
chapter on https://demo.pygeoapi.io setup as example (Docker proxy-ing etc), instances and CITE?

Nice writeup from OSGeo perspective: https://blog.astuntechnology.com/2019/12/improving-project-documentation-with.html

tomkralidis commented 4 years ago

Thanks @justb4 I've added a deployment section to the above, as well as an OGC CITE compliance section, which should cover our CITE support/story/workflow (including how to test).

justb4 commented 4 years ago

section suggestion: "Further Reading/Info": with links to presentations (slides, video) and..

tomkralidis commented 4 years ago

Implemented in #392.