Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Link to Hosted documents in readme #78

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Fix Link to Hosted documents in readme #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -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.
. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.