docker / docker/buildx

better descriptions for buildx commands in the documentation

Open
#610 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4.5k
Forks
682
Avg merge
2d 14h
Merged PRs (30d)
29

Description

Descriptions for the buildx commands in the documentation could be improved.
Currently, the top level description for bake is "Build from a file" which doesn't tell me much about why I would want to use the bake command in particular.
buildx itself just says "Build with BuildKit".
There are better descriptions further down, but folks might miss those.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the buildx command documentation and the top-level descriptions for buildx and bake. Compare those short descriptions with the more detailed descriptions later in the documentation, then update the summaries so they explain the commands' purposes; done when both top-level descriptions are more informative.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
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.