bazelbuild / bazelbuild/bazel

Command line completion documentation is incomplete

Open
#16,651 0 comments 0 reactions 0 assignees View on GitHub
help wanted P2 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

There is some documentation of [command line completion](https://bazel.build/install/completion), focused on how to install it. To my surprise, it doesn't discuss what I assume to be the most common scenario, i.e. bazel installed via bazelisk. (I assume you need to follow the bootstrapping instructions in this case, but it's far from obvious!)

It would be great if the documentation explicitly discussed how to enable completion when bazel is installed using bazelisk.

Contributor guide

Open the contributing guide

Research direction

Start with the linked command line completion documentation and read its installation and bootstrapping instructions. Document the steps needed to enable completion when Bazel is installed through Bazelisk, and consider the work done when that common setup is explicit and unambiguous.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.