You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The HTML files for the various extensions currently in the repository were generated with various versions of asciidoc or asciidoctor and we do not currently check that the HTML files in the repository match the corresponding asciidoc source.
Following the introduction of an official toolchain in #247, we should add automation to guarantee that:
All asciidoc sources are free from syntax errors (many of the files currently in the repo contain errors)
The HTML files correspond to the asciidoc source and have been generated with the official toolchain or, better still, remove them from the repo and publish them automatically.
I think the following sequence of steps should get us there:
The text was updated successfully, but these errors were encountered:
kpet
changed the title
Check HTML spec generation and asciidoc validity in CI
Automatically generate HTML specs and publish them via Github Pages
Aug 14, 2024
2024/08/14 teleconference: consensus in the group to skip automatic checking of the HTML files as a step and transition directly to automatically publishing HTML specs via Github Pages and remove HTML files from the repo.
In case it helps other vendors updating their extension specs: One of the differences I noticed updating the Intel specs was that text in 'single quotes' is rendered as italics using asciidoc, but not always using asciidoctor. I couldn't figure out how to make the single quote method work reliably, and it's not documented in the asciidoctor docs, so I ended up switching everything to use _underscores_ for italics instead.
The HTML files for the various extensions currently in the repository were generated with various versions of asciidoc or asciidoctor and we do not currently check that the HTML files in the repository match the corresponding asciidoc source.
Following the introduction of an official toolchain in #247, we should add automation to guarantee that:
I think the following sequence of steps should get us there:
No longer doing:
The text was updated successfully, but these errors were encountered: