bazelbuild/bazel

Refocus installation instructions on Bazelisk

Open

#10,348 opened on Dec 2, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-OSStype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (PR metrics pending)

Description

I’ve noticed that the installation guide 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

Research direction
Review the current installation guide at the provided URL and understand how to install Bazel directly. Then research Bazelisk and determine how to update the installation instructions to recommend Bazelisk as the primary method. Write the updated documentation.
Tech stack
None
Domain
tooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85