bazel-website icon indicating copy to clipboard operation
bazel-website copied to clipboard

Add contribution guidelines for Bazel documentation

Open davidzchen opened this issue 8 years ago • 4 comments

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).

davidzchen avatar Aug 31 '16 09:08 davidzchen

To start simple, let's at least explain which version of Jekyll is needed, and that serve-docs.sh must be used to run the docs.

steren avatar May 15 '17 08:05 steren

Marking this as P2 as the build is getting more complex, and we should have documentation around this.

jin avatar Dec 17 '18 18:12 jin

What's the status of this?

meisterT avatar May 15 '20 07:05 meisterT

This should be on the Contribution section on bazel-website. I'll take an action item to make public our doc development instructions.

Transferring this to the bazelbuild/bazel-website repo.

jin avatar May 15 '20 08:05 jin