From 1b5d6d64db48a1b33359bb0bdeb9f3d989010667 Mon Sep 17 00:00:00 2001 From: florianwallerer <97514881+florianwallerer@users.noreply.github.com> Date: Mon, 17 Jun 2024 15:11:16 +0200 Subject: [PATCH] Fix Link to Hosted documents in readme Out commented Asciidoc Information. And changed Link to hosted documents. --- README.adoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index 79050af6..459100af 100644 --- a/README.adoc +++ b/README.adoc @@ -1,22 +1,24 @@ = OSI Documentation This repo hosts the AsciiDoc-based part of the documentation. -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]. +It contains generals parts of the content and a CI-pipeline that renders the document with Antora. // TODO: Update if Asciidoctor is completely dropped! == ASAM OSI (R) official documentation -See the documentation https://opensimulationinterface.github.io/osi-documentation/[here]. +See the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here]. == Build pipeline -=== Asciidoctor pipeline +// === Asciidoctor pipeline -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] +// The Asciidoctor pipline is no longer active, see Antora pipeline. -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. -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]. +// 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] + +// 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. +// 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]. === Antora pipeline 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. docker-compose run asciidoctor ---- -. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation. \ No newline at end of file +. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.