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.

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

Automatically generate HTML specs and publish them via Github Pages #270

Open
7 of 14 tasks
kpet opened this issue Aug 8, 2024 · 2 comments
Open
7 of 14 tasks

Automatically generate HTML specs and publish them via Github Pages #270

kpet opened this issue Aug 8, 2024 · 2 comments

Comments

@kpet
Copy link
Contributor

kpet commented Aug 8, 2024

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:

No longer doing:

@kpet 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
@kpet
Copy link
Contributor Author

kpet commented 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.

@bashbaug
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants