|
1 | 1 | = OSI Documentation |
2 | 2 |
|
3 | 3 | This repo hosts the AsciiDoc-based part of the documentation. |
4 | | -It contains generals parts of the content and a CI-pipeline that renders the document with Asciidoctor and deploys it to the https://opensimulationinterface.github.io/osi-documentation/[gh-pages of this repo]. |
| 4 | +It contains generals parts of the content and a CI-pipeline that renders the document with Antora. |
5 | 5 |
|
6 | 6 | // TODO: Update if Asciidoctor is completely dropped! |
7 | 7 |
|
8 | 8 | == ASAM OSI (R) official documentation |
9 | 9 |
|
10 | | -See the documentation https://opensimulationinterface.github.io/osi-documentation/[here]. |
| 10 | +See the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here]. |
11 | 11 |
|
12 | 12 |
|
13 | 13 | == Build pipeline |
14 | | -=== Asciidoctor pipeline |
| 14 | +// === Asciidoctor pipeline |
15 | 15 |
|
16 | | -image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml] |
| 16 | +// The Asciidoctor pipline is no longer active, see Antora pipeline. |
17 | 17 |
|
18 | | -The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo. |
19 | | -As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc]. |
| 18 | +// image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml] |
| 19 | + |
| 20 | +// The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo. |
| 21 | +// As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc]. |
20 | 22 |
|
21 | 23 | === Antora pipeline |
22 | 24 | image::https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml/badge.svg?branch=main[link=https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml] |
@@ -78,4 +80,4 @@ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging. |
78 | 80 | docker-compose run asciidoctor |
79 | 81 | ---- |
80 | 82 |
|
81 | | -. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation. |
| 83 | +. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation. |
0 commit comments