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
{{ message }}
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.
Due the the fact that some of the Bazel documentation (such as the User Manual, Test Encyclopedia, most of the Skylark docs, etc.) are also published internally, and due to some annoying differences between the internal documentation framework and Jekyll (namely .md links rather than .html), it would be a good idea to provide some documentation in the Contribution Guidelines around this.
In particular, perhaps we should clarify which kinds of documentation changes should be avoided, such as changing .md links to .html for docs that are also published internally.
Some other ideas that might be useful:
Documentation linter for catching these kinds of changes.
Tests for validating the docs generated by //site:jekyll-tree (such as verifying that the jekyll-tree.sh script correctly converted all .md links to .html.
Adding a design doc describing how the external documentation pipeline works (from Build Encyclopedia and Skylark Library docgen to packaging the Jekyll tree).
The text was updated successfully, but these errors were encountered:
Due the the fact that some of the Bazel documentation (such as the User Manual, Test Encyclopedia, most of the Skylark docs, etc.) are also published internally, and due to some annoying differences between the internal documentation framework and Jekyll (namely
.md
links rather than.html
), it would be a good idea to provide some documentation in the Contribution Guidelines around this.In particular, perhaps we should clarify which kinds of documentation changes should be avoided, such as changing
.md
links to.html
for docs that are also published internally.Some other ideas that might be useful:
//site:jekyll-tree
(such as verifying that thejekyll-tree.sh
script correctly converted all.md
links to.html
.The text was updated successfully, but these errors were encountered: