Uses pandoc to convert the manpage into a markdown document and add it
to the mkdocs documentation.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
The `simple/linkedin` icon is no longer available in mkdocs-material
v9.6.4. The `material/linkedin` icon is now used instead. To harmonize
all icons, the youtube icon is also changed to `material/youtube`.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
In order to adjust the resulting markdown files to our needs, the
upstream markdown template[^1] is added. The markdown template itself is
added to exclude_docs in the mkdocs.yaml file.
[^1]: https://github.com/pseudomuto/protoc-gen-doc/blob/master/resources/markdown.tmpl
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com
Adds the AAP2 and StorageAgent protobuf reference to the documentation
by generating markdown files using protoc-gen-doc and adding them as
input for mkdocs.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
This moves most of the extended instructions to the mkDocs pages. The
intention is to keep the bare minimum in the README for developers that
just want to quickly try it out.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This adds a page explaining the use of the Python module to build an AAP
2.0 client and links it from the corresponding page.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This adds a page to the web documentation that provides a high-level
overview of µD3TN's architecture. The existing architecture figure is
updated and renamed appropriately.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
Fixes a warning. index.md is the doc index, whereas README.md is for
developers who want to build the mkDocs site.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This performs the following actions:
- change overall documentation tree to adjust to existing material
- add CSS for improved visuals
- add folders to improve structure
- move the README of the Contact Plan Reader to the doc folder and integrate it into the documentation
- add file for 'Home' to provide a starting point for the documentation
Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com>
