Write (mk)docs for DJAM

giohappy commented 4 days ago

DJAM needs proper documentation. We can use Markdown files under the docs/ folder to organize the chapters, and use a basic MkDocs configuration (see the one we used for the QGIS GeoNode Plugin as an example).

Chapters:

[x] Home (we can start by taking the content from the current README) -> @Gpetrak
[x] API Keys -> @Gpetrak
[ ] OpenID/Oauth2
[ ] Authenticated Proxy service
[x] Integration with Geoserver (to be reviewed) -> @Gpetrak
[ ] Integration with GeoNode
[x] REST API (initially we can just report the API for the API Key management) @Gpetrak

Gpetrak commented 4 days ago

@giohappy the estimated time for this task is 2 days.

giohappy commented 3 days ago

@Gpetrak do your best in 1 day then we'll see, ok?

Gpetrak commented 3 days ago

@giohappy ok.

Gpetrak commented 2 days ago

@giohappy the PR for this task is available here We can discuss about the content of the README.md file since, now it is included in the docs/index.md.

Gpetrak commented 2 days ago

@giohappy I created a PR directly to the main branch in which I added the link of the documentation and removed the content which exists in docs/index.md

geosolutions-it / djam

Write (mk)docs for DJAM #37