Documentation for the HIFIS Cloud and AAI
This repository contains the documentation for all aspects of the HIFIS cloud and Backbone AAI.
The documentation is deployed to and publically available at https://hifis.net/doc/.
Conventions
Markdown is the common format for the documentation. For the general syntax see https://www.markdownguide.org/basic-syntax.
Contribute
You can contribute by logging in via Helmholtz AAI, create a branch from master, do you suggested changes and invite a project maintainer to review (and possibly merge) your changes.
External Resources
- This documentation uses Kroki diagams. See introduction here. For local builds, you need to install the kroki plugin with
pip install mkdocs-kroki-plugin.
The repository is public readable and it is writable for Helmholtz AAI logged in persons.
Builds
- Master build review app (password required):
https://hifis-review-app.hzdr.de/review-apps/hifis-hifis-technical-documentation/master/ - Download latest master build:
https://gitlab.hzdr.de/hifis/hifis-technical-documentation/-/jobs/artifacts/master/download?job=build - Browse latest master build:
https://gitlab.hzdr.de/hifis/hifis-technical-documentation/-/jobs/artifacts/master/browse/public?job=build