Convert build scripts to asciidoctor

Created on 11 July 2024, 5 months ago
Updated 28 August 2024, 4 months ago

Problem/Motivation

Right now all the build scripts use the old Python asciidoc parser but it isn't very well supported anymore. Instead, we should switch to using asciidoctor which is currently the most used and well supported parser. This should help to simplify the requirements for setting up an environment that can build the user guide. And potentially open up the door for doing some new things like generating a static site version of the guide.

Proposed resolution

Update all the build scripts and configuration to use asciidoctor.

Remaining tasks

  • Update the scripts in scripts/ directory
  • Update documentation
  • Any updates to Asciidoc syntax in current files to make the text compatible with asciidoctor.

One thing we'll have to figure out how to handle is our custom admonitions for embedding videos into guide pages.

πŸ“Œ Task
Status

Active

Version

10.3

Component

Scripts

Created by

πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @eojthebrave
  • πŸ‡ΊπŸ‡ΈUnited States drumm NY, US

    As part of this, the build should take place in GitLab CI, so the dependencies/etc only need to be figured out for building in one place.

Production build 0.71.5 2024