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

Simplify HTML rendering build process #3852

Closed
handrews opened this issue May 24, 2024 · 1 comment · Fixed by #3944
Closed

Simplify HTML rendering build process #3852

handrews opened this issue May 24, 2024 · 1 comment · Fixed by #3944
Assignees
Labels
Housekeeping script Pull requests that update Bash or JavaScript code

Comments

@handrews
Copy link
Member

handrews commented May 24, 2024

Currently, to build the HTML versions of the spec, you need to simulate .github/workflows/respec.yam by doing (in the root of a checked-out main branch of the repository):

  1. make sure you have node version 20 installed
  2. npm install
  3. ./scripts/md2html/build.sh
  4. git checkout gh-pages
  5. cp -R js deploy/js

Then you can look at the rendered HTML. After the first time you only have to do the ./scripts/md2html/build.sh (from main).

If you need to render a new version of the spec, you also need to add a new MAINTAINERS_vX.Y.Z.md file in the scripts/md2html/history directory (which the error message you get will show as ./history).

We should fix this as we fix #3717, #3845, and #3715.

@handrews handrews added Housekeeping script Pull requests that update Bash or JavaScript code labels May 24, 2024
@handrews
Copy link
Member Author

We should also figure out how much of our custom md2html.js is still needed now that GitHub handles section links differently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping script Pull requests that update Bash or JavaScript code
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants