This is the repository of the official technical documentation of POSSIBLE-X, the Gaia-X data space implementation of the POSSIBLE project.
- Made with MkDocs - https://www.mkdocs.org/
- User Guide: https://www.mkdocs.org/user-guide/writing-your-docs/
- It is available here https://possible-x.github.io/documentation
- Python 3 (tested with 3.11.1)
- Pip 3
- A Virtual Environment is recommended
- Clone the repository and navigate into the directory
$ pip install -r requirements.txt
- Develop and preview with Live Reload
$ mkdocs serve
- Build the documentation
$ mkdocs build -f mkdocs.yml -d build
The directories contain the following content:
The actual Markdown files to create the documentation.
Raw material used in the documentation.
- Documentation and illustrations of the POSSIBLE-X architecture
- Documentation of the cloud infrastructure
- Developer Documentation for Eclipse Minimum Viable Dataspace: https://github.com/eclipse-edc/MinimumViableDataspace/tree/main/docs/developer