Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some links in README.md are not found #2843

Open
shenxianpeng opened this issue Dec 6, 2024 · 3 comments
Open

Some links in README.md are not found #2843

shenxianpeng opened this issue Dec 6, 2024 · 3 comments
Assignees
Labels
Milestone

Comments

@shenxianpeng
Copy link

The following links docker buildx install and docker buildx uninstall in README.md are not found.

Running the command docker buildx install sets up docker builder command as an alias to docker buildx build. This results in the ability to have docker build use the current buildx builder.

To remove this alias, run docker buildx uninstall.

@tonistiigi tonistiigi added this to the v0.20.0 milestone Dec 6, 2024
@crazy-max
Copy link
Member

I think this relates to a change in docs generation where hidden commands don't generate documentation anymore, which makes sense imo:

@dvdksn I wonder if we could just remove this section from the README: https://github.com/docker/buildx?tab=readme-ov-file#set-buildx-as-the-default-builder and add it to https://docs.docker.com/build/concepts/overview/#buildx instead without links to cli ref?

@dvdksn
Copy link
Contributor

dvdksn commented Dec 16, 2024

@crazy-max yeah we can do that. I could also clarify the discrepancy between a vanilla docker build and a docker buildx build w.r.t. default builder.

@dvdksn dvdksn self-assigned this Dec 16, 2024
@crazy-max
Copy link
Member

I could also clarify the discrepancy between a vanilla docker build and a docker buildx build w.r.t. default builder.

Ah true we should explain this. I see this content that is almost correct: https://docs.docker.com/build/concepts/overview/#buildx

Buildx and BuildKit are both installed with Docker Desktop and Docker Engine out-of-the-box. When you invoke the docker build command, you're using Buildx to run a build using the default BuildKit bundled with Docker.

We could add here how builder selection works when docker build is invoked vs docker buildx build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants