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>
This adds a function to decode JSON configuration via Jansson to the
router agent. The JSON functionality and, thus, the dependency on
Jansson, can be disabled during the build process by setting the
`DISABLE_JSON` compile-time flag (see `config.mk.example` for details).
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
- Add `make doc` target to run protoc-gen-doc before mkdocs
- Ignore auto generated markdown files
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
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>
This moves the 'build_plantuml.sh' file to the 'image-material' directory, and takes on a more generic approach for the CSS changes.
Signed-off-by: Fiona Fuchs <fiona.fuchs@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>
Adds a MkDocs configuration and directory, as well as a Nix derivation
for creating HTML files. Since we do not want to add the MkDocs
documentation to the overlay, `self` is passed to `shell.nix` to inherit
the inputs from the packages.
The inline code documentation is added to the MkDocs HTML output using
the plugins `mkdoxy` for C code and `mkdocstrings` for Python code.
Adds an job to the CI to build and deploy the documentation at
https://d3tn.gitlab.io/ud3tn/.
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
As AAP does not provide TLS support, a user exposing it on a TCP socket
should know what they are doing and set up appropriate firewall rules.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This allows for using AAP 2.0 over TCP, which the Python tools support
already. Note that the user must make sure that the socket is not
exposed externally.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
We did not really explain how to deal with node restarts beforehand.
This adds some hints to the quick start guide and the SQLite CLA docs.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
We do not render it with `pandoc` automatically and it looks like an
artifact in GitLab. In the rendered version it is not really necessary
as well -- in our case it means just that the heading will receive a
number which is OK in my opinion.
Signed-off-by: Felix Walter <felix.walter@d3tn.com>
