IDOML Documentation repository

This repository contains the documentation for the IDOML platform. The documentation is written in markdown and is built using MkDocs. The documentation is hosted on GitHub pages and can be accessed here.

Local development

To build the documentation locally, you need to have Python installed. You can install the required dependencies by running the following command:

pip install mkdocs-material pymdown-extensions Pygments

To serve locally the documentation, run the following command:

mkdocs serve

The documentation will be available at http://localhost:8000/.

Deployment

The documentation is automatically deployed to GitHub pages under this link using GitHub actions. The configuration for the deployment can be found in the .github/workflows/mkdocs.yml file.

Two types of deployment are supported:

• Pushing to the main branch will trigger the deployment of the documentation. This will build the documentation and push the changes to the gh-pages branch. The change will be reflected with develop version of documentation here.

• Adding and pushing a tag to the main branch will trigger the deployment of the versioning documentation. Please make sure to follow the versioning convention X.Y.Z.This will build the documentation and push the changes to the specific version documentation. The change will be reflected https://serval-uni-lu.github.io/idoml-docs/X.Y.Z, where X.Y.Z is the version number defined in the tag.

Command for creating a new version in main branch:

git tag -a X.Y.Z -m "Version X.Y.Z description"
git push origin X.Y.Z