Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write (mk)docs for DJAM #37

Open
4 of 7 tasks
giohappy opened this issue Sep 23, 2024 · 5 comments
Open
4 of 7 tasks

Write (mk)docs for DJAM #37

giohappy opened this issue Sep 23, 2024 · 5 comments
Assignees

Comments

@giohappy
Copy link
Contributor

giohappy commented Sep 23, 2024

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:

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

Gpetrak commented Sep 24, 2024

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

@giohappy
Copy link
Contributor Author

giohappy commented Sep 24, 2024

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

@Gpetrak
Copy link
Contributor

Gpetrak commented Sep 24, 2024

@giohappy ok.

@Gpetrak
Copy link
Contributor

Gpetrak commented Sep 25, 2024

@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
Copy link
Contributor

Gpetrak commented Sep 26, 2024

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants