README.md

cloud-docs

Documentation for Cloud v2. The docs are written in markdown using MkDocs. The docs are automatically built & deployed when pushing to the main branch and the docs are available on cloud.incendo.org. Each PR will deploy a temporary preview version of the site.

Install & Build

You can install MkDocs by using

$ python3 -m pip install -r docs/requirements.txt

and then you may run MkDocs locally using

$ python3 -m mkdocs serve

after which the docs will be available at http://127.0.0.1:8000/. The built site will auto-refresh when the files are updated.

Prettier

We use prettier to validate the files when building the project. It is recommended that you install prettier and run it when you make changes. You can find instructions here.

You may also install prettier & husky using npm, which will also add a pre-commit hook which formats the files for you:

$ npm install

then you may run prettier using:

$ npx prettier . --write

Snippets

The code directory contains a Gradle project with compiled examples. Snippets from these docs are used in the examples using the {{ snippet("File.java") }} macro. The project will be built by the CI pipeline to validate that the snippets compile.