-
Notifications
You must be signed in to change notification settings - Fork 8.1k
build: add guides #14905
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
build: add guides #14905
Conversation
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
dockertopia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should (all) be in manuals, we're listing feature and giving some samples. It's not an actual tutorial with a use case behind (as far as I can see) it.
| - dest: "build/guides" | ||
| src: | ||
| - "docs/guides/*.md" | ||
| - "!docs/guides/cicd.md" # CI/CD documentation is already handled in ci-cd/github-actions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what we're doing here, is this about removing something from the docs that is some repo? If so, I'm not sure that is the right way forward.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are fetching markdown files from buildx repo in https://github.com/docker/buildx/tree/master/docs/guides (except ci-cd) and add them to build/guides folder here.
Will be available in Manuals > Docker Build > Guides. See https://deploy-preview-14905--docsdocker.netlify.app/build/guides/cni-networking/
dockertopia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@crazy-max I think we can move this asap to Build doc set, but I think it would make more sense to have it all in the Manuals to have users understand in one place all functionality BuildKit introduces. Build cmd might redirect to buildx but I'm not use if it's not more confusing for the users to change the guide to building with buildKit.
This comment was marked as outdated.
This comment was marked as outdated.
fbb6281 to
7dab831
Compare
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
|
moving to draft as we might create stub files so we can maintain frontmatter section here. see #15165 for more info. |
jedevc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks mostly good to me, I think we'd probably want to do some follow-ups to improve the consistency of our buildx docs - but it'll be good to have this info on the docs site I think.
| title: Build contexts and linking targets | ||
| - path: /build/bake/compose-file/ | ||
| title: Building from Compose file | ||
| - sectiontitle: Guides |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh this seems strange to me, but not sure whether there's a better alternative.
Having a section in Manuals called Guides, when we have a Guides category 🤔 I feel like it's better to maybe be consistent with the rest of our docs for now, and put it into Guides?
Other options:
- Don't call them "Guides" but something like "Advanced usage"? But then of course, what happens if we add more entry-level guides/tutorials, do those go into the guides section (splitting them up), or do we keep them together, which seems inconsistent with the rest of the docs.
- Rework the buildkit guides to be more like the guides in the rest of the docs, by making them more tutorial like, etc - maybe the remote builder guide is already like this in style?
| - path: /build/guides/registry-mirror/ | ||
| title: Define a registry mirror | ||
| - path: /build/guides/remote-builder/ | ||
| title: Remote builder |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should group this near the kubernetes builder. Maybe we also want to call it <x>-driver instead of <x>-builder - really not sure on that though.
| GitHub repository. | ||
| ## High-level build options with Bake | ||
|
|
||
| Check out our guide about [Bake](../bake/index.md) to get started with the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to call out that bake is still experimental here as well?
|
Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a Prevent pull requests from auto-closing with a /lifecycle stale |
follow-up #14644
needs docker/buildx#1140 so keeping in draft for nowFetch build guides
and bakefrom upstream buildx repo in https://github.com/docker/buildx/tree/master/docs/guides