OSI Documentation

This repo contains most of the general AsciiDoc-based part of the documentation. It contains generals parts of the content and a CI-pipeline that renders the document with Antora.

Note	The actual hosting has been moved to the generator repository (see link below).

ASAM OSI ® official documentation

See the documentation here.

License

The documentation was originally licensed under the CC-BY-3.0 license. Starting with OSI version 3.8.0, it is additionally dual-licensed under the MPL-2.0 license used by all other parts of OSI to ensure harmonization. With the release of the major version OSI 4.0.0, the CC BY 3.0 license will be discontinued and removed.

Antora build pipeline

Note	This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator.

How To build and change documentation locally

Important

These instructions relate ONLY to the Asciidoctor build. For Antora, check the ASAM OSI Antora generator.

The following instructions show how to build the document locally. Take note that the document is built with a version 'localbuild' in the document and filename.

The instruction should work on Windows, Linux, and MacOS.

1. Precondition: have docker and docker-compose installed.

   Tip	Official installation can be found here.

2. Clone this repository with submodules.

   git clone https://github.com/OpenSimulationInterface/osi-documentation.git
   git submodule update --init

3. Clone OSI and OSMP with submodules into the osi-documentation folder

   cd osi-documentation
   git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git
   git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git

4. Check file docker-compose.yml with the following content:

   version: "2"services:
   asciidoctor:
   image: asciidoctor/docker-asciidoctor:1volumes:
   - .:/documentsworking_dir: /documentsentrypoint: asciidoctor -D . --failure-level WARN -r asciidoctor-bibtex -r asciidoctor-diagram -a mathjax --trace --backend=html5 index.adoc -o open-simulation-interface_localbuild.html

5. Run

   docker-compose run asciidoctor

6. Result: Document is build as open-simulation-interface_localbuild.html in the folder osi-documentation.