Map of Zones docs is a project documentation static site. Used static site generator MkDocs, and some extensions.
- Python (3.8, 3.9 or later) - python.org/downloads
- Pip [via python] (20.0.2 or later) -
python get-pip.py
- MkDocs [via pip] (1.1.2 or later) -
pip install mkdocs
- MkDocs-diagrams [via pip] (v1.0.0 or later) -
pip install mkdocs-diagrams
- Graphviz dot (2.44.1 or later) - graphviz.org/download
mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.
-
Pages - project documentation with Markdown. User guides: mkdocs.org/user-guide
-
Diagram as Code - diagrams lets you draw the cloud system architecture in Python code. Examples: diagrams.mingrammer.com
-
GraphQL schema - just install graphqurl via:
npm install -g graphqurl
then use this for guest:gq https://<your_ip>/v1/graphql --introspect > schema.graphql
or this for admin:gq https://<your_ip>/v1/graphql -H "X-Hasura-Admin-Secret: <your_adminsecretkey>" --introspect > schema.graphql
source: hasura.io/docs/latest/graphql/core/guides/export-graphql-schema -
GraphQL schema to markdown - install library via:
npm install graphql-markdown --save-dev
then transform graphql to markdown:graphql-markdown ./path/to/schema.graphql > schema.md
source: github.com/exogen/graphql-markdown -
Schematic images - each image (eg architecture) is stored as a
jpg
orpng
image, but besides that there is anxml
of that image unloaded fromdrawio
in google drive. For further work, you can importxml
schemes intodrawio
on google drive, re-create the schemes there and then export the new version of the scheme topng
andxml
.
Just push your changes to github. On changes in the master branch, github actions will automatically prepare the build. If the build is successful, the new version of the static site will be located in the gh-pages branch and deployed automatically.