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

Refresh the instructions for building the docs #1145

Merged

Conversation

johnbartholomew
Copy link
Collaborator

Various minor changes:

  • gitignore the Jekyll output directory even if you run Jekyll from the repo root.
  • gitignore the WASM file since it's a build output.
  • Delete tools/scripts/serve_docs.sh - it's no longer needed since Jekyll 4.3.0 which fixed the Content-Type for WASM files (Fix response header for content served via jekyll serve jekyll/jekyll#8965) 4.3.0 was released October 2020.
  • In push_docs, when checking out the repo to the working directory, directly check out the gh-pages branch instead of checking out HEAD and then switching branch.
  • Update instructions accordingly.

Various minor changes:
- gitignore the Jekyll output directory even if you run Jekyll from
  the repo root.
- gitignore the WASM file since it's a build output.
- Get rid of tools/scripts/serve_docs.sh - it's no longer needed since
  Jekyll 4.3.0 which fixed the Content-Type for WASM files
  (jekyll/jekyll#8965)
  4.3.0 was released October 2020.
- In push_docs, when checking out the repo to the working directory,
  directly check out the gh-pages branch instead of checking out HEAD
  and then switching branch.
- Update instructions accordingly.
@johnbartholomew johnbartholomew merged commit c4c7464 into google:master Apr 16, 2024
6 checks passed
@johnbartholomew johnbartholomew deleted the update-doc-instructions branch April 16, 2024 13:44
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

Successfully merging this pull request may close these issues.

1 participant