summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPhilip Molares2021-01-04 14:26:39 +0100
committerPhilip Molares2021-01-04 14:26:39 +0100
commit90371c1c000ccfe884f165273ee8f4e459f0307f (patch)
tree0944d95b5fcd6d2ca577aaaf72fe39fca5d07d47 /docs
parent825d56f2168595e3ab28c6bd438c1701c7cebfbf (diff)
added documentation about how the write, build and deploy this
documentation. Signed-off-by: Philip Molares <philip.molares@udo.edu>
Diffstat (limited to '')
-rw-r--r--docs/dev/documentation.md27
-rw-r--r--docs/dev/getting-started.md2
2 files changed, 28 insertions, 1 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
new file mode 100644
index 00000000..aa3c5253
--- /dev/null
+++ b/docs/dev/documentation.md
@@ -0,0 +1,27 @@
+# Documentation
+
+Our documentation is build with [mkdocs](https://www.mkdocs.org).
+
+## Writing
+
+All documentation files are found in the `docs` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them.
+
+The config file for mkdocs lies in the root of the repo in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured.
+**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website.
+
+## Building
+
+To build the documentation locally you need to perform the following steps:
+
+1. make sure you have python3 installed
+2. install all the dependencies possibly with a [venv](https://docs.python.org/3/library/venv.html):
+`pip install -r mkdocs.requirements.txt`
+3. start the mkdocs dev server `mkdocs serve` or let it build the documentation `mkdocs build`
+
+## Deployment
+
+The documentation is deployed with [Messor Structor](https://github.com/traefik/structor).
+
+The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io.
+
+Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*` and build each one seperatly via `mkdocs` by first installing `mkdocs.requirements.txt` and then building. Afterwards the menu go template is used to include a version switcher in the theme and make all the different versions available. \ No newline at end of file
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md
index b0623926..b7787117 100644
--- a/docs/dev/getting-started.md
+++ b/docs/dev/getting-started.md
@@ -1,4 +1,4 @@
-# Developer Notes
+# Getting started
## Preparing for running the code