Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

Add contribution guidelines for Bazel documentation #241

Open
davidzchen opened this issue Aug 31, 2016 · 4 comments
Open

Add contribution guidelines for Bazel documentation #241

davidzchen opened this issue Aug 31, 2016 · 4 comments
Assignees

Comments

@davidzchen
Copy link
Member

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 davidzchen self-assigned this Aug 31, 2016
@steren
Copy link
Contributor

steren commented May 15, 2017

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.

@jin
Copy link
Member

jin commented Dec 17, 2018

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

@jin jin assigned jin and unassigned davidzchen and michelleirvine Dec 17, 2018
@jin jin removed their assignment Jan 3, 2019
@meisterT
Copy link
Member

What's the status of this?

@jin
Copy link
Member

jin commented May 15, 2020

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 jin transferred this issue from bazelbuild/bazel May 15, 2020
@jin jin self-assigned this May 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants