bazelbuild / bazelbuild/bazel

Refocus installation instructions on Bazelisk

Open
#10,348 1 comment 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-OSS type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

I’ve noticed that [the installation guide](https://docs.bazel.build/versions/master/install-os-x.html) is focused on installing Bazel directly into a system. However, it seems like Bazelisk is a preferred way of managing Bazel versions, like the Gradle wrapper is. Shouldn’t we refocus the documentation on using Bazelisk instead, omitting direct Bazel installation guides? I think it might push users into the right direction. I can be completely wrong about this however since I’m very new to the scene. I can work on it if it makes sense.

Contributor guide

Open the contributing guide

Research direction

Start with the linked macOS installation guide and review how it presents direct Bazel installation. Compare that guidance with the issue’s proposal to center Bazelisk, then update the relevant installation documentation so the preferred approach is clear and the completion criteria are consistent guidance across the affected instructions.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.