Skip to content

WP22: Documentation update to Antora #667

Closed
@philipwindecker

Description

@philipwindecker

Describe the feature

To unify documentation and utilize the added functionality of Antora as specified in WP22 of the latest Proposal, each content repository has to be updated in its structure and its pipeline be analyzed and possibly updated.

Describe the solution you would like

  • Add the necessary folders and files for Antora (use symlinks to keep Asciidoctor compatibility)
  • Add required headers to each AsciiDoc file for backward compatibility with Asciidoctor

Describe alternatives you have considered

Stick with the existing but separate documentation style.

Describe the backwards compatibility

This is a build-related issue. The content of the standard is not impacted whatsoever. However, in order to be compliant with Antora folder structures, all relevant versions would have to be updated. Since this is quite some overhead, only the latest release (3.5.0) is converted and all previous ASAM releases will be linked as external links.

Additional context

The Antora result is rendered through the OSI generator repository and hosted on the GitHub pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ReadyForCCBReviewIndicates that this MR is ready for a final review and merge by the CCB.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions