Bazel Blog

A call for contributions to Bazel’s documentation

Last year, we made significant changes to Bazel’s documentation website (bazel.build) to elevate overall developer experience. By redesigning the site’s architecture, we’ve made it easier for the community to contribute new documentation and add more content.

In 2023, we aim to improve Bazel’s documentation and eliminate common issues. We can achieve this goal by reducing the number of open GitHub documentation issues in a sustainable way.

Here’s where we’d like your support:

  1. Join our Slack channel! This is where we will collaborate and engage with you on documentation contributions.
  2. Look through the pre-filtered link of open issues in the bazelbuild/bazel repository. (Optionally, you can filter by issues labeled “team-Documentation” and “help wanted” yourself.)
  3. Identify issues that you can assist with. Add a comment to the issues to let other community members know that you are working on them.
  4. If you’re new to this community, look out for issues labeled “good first issue” - these are handpicked by the Bazel team as good introductory problems to work on.
  5. Go to the page you would like to update and click on the “View Source” button found on top. This will direct you to the correct file in the docs section of the repository. Make the required updates and submit a PR.

Image

And that’s it! Our new internal processes will take care of the rest.

We encourage you all to contribute to Bazel’s documentation! By sharing what you know and learn, you’re helping us grow, strengthen, and foster our amazing community of developers. Let us know if we can help in any way during the process - reach out to Radhika Advani on Slack, or post on our dedicated channel.

Make sure to check out Lyra Levin’s lightning talk from BazelCon 2022 on documentation barriers and benefits!