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

Add documentation as a Docker service and landing page #8

Closed
justb4 opened this issue May 25, 2021 · 1 comment
Closed

Add documentation as a Docker service and landing page #8

justb4 opened this issue May 25, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@justb4
Copy link
Contributor

justb4 commented May 25, 2021

Idea is to add the documentation, possibly as the landing "home" page for the testbed server.

mkdocs seems best option, also to maintain (mainly markdown/.md files).

Bij adding as a Docker service similar to Traefik and pygeoapi, committing will automatically publish a new docs version.
Other option is to host on GitHub, but my pref is as a service so the server is self-contained.

There is even a choice of Themes:
https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes

@justb4 justb4 self-assigned this May 25, 2021
@justb4 justb4 added documentation Improvements or additions to documentation enhancement New feature or request labels May 25, 2021
justb4 added a commit that referenced this issue May 25, 2021
justb4 added a commit that referenced this issue May 26, 2021
@justb4
Copy link
Contributor Author

justb4 commented May 26, 2021

This has been done. Next need to enhance with nice mkdocs-theme and content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant