bazelbuild / bazelbuild/bazel

The tutorials and example code are inconsistent w.r.t. versioning.

Open
#13,298 0 comments 0 reactions 1 assignee Claimed by @jdob View on GitHub
P2 team-Documentation team-Rules-CPP type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 18h
Merged PRs (30d)
75

Description

Tutorials start in the versioned docs set. https://docs.bazel.build/versions/4.0.0/tutorial/cpp.html
But the examples they point to are in https://github.com/bazelbuild/examples, and not versioned.

This means that as Bazel evolves, the examples should change too. But then, the tutorials for older LTS versions of Bazel might point to broken examples.

A better situation would be for the tutorial pages to live in the examples repository, and only have links from the main bazel docs into the examples repo.

We can reorg the example tree so there is a top root that specifies bazel track (2, 3, 4, ...). At the beginning of a new LTS cycle we copy the most recent tree to the new one and tweak as appropriate.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.