Skip to content

Conversation

@crazy-max
Copy link
Member

@crazy-max crazy-max commented Jun 9, 2022

follow-up #14644

needs docker/buildx#1140 so keeping in draft for now

Fetch build guides and bake from upstream buildx repo in https://github.com/docker/buildx/tree/master/docs/guides

@crazy-max crazy-max requested a review from dockertopia June 9, 2022 11:54
@netlify
Copy link

netlify bot commented Jun 9, 2022

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c492b57
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/62d77c672426140009d9e84c
😎 Deploy Preview https://deploy-preview-14905--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@crazy-max crazy-max marked this pull request as ready for review June 10, 2022 08:03
@usha-mandya usha-mandya added the area/build Relates to Dockerfiles or docker build command label Jun 29, 2022
Copy link
Contributor

@dockertopia dockertopia left a 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
Copy link
Contributor

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.

Copy link
Member Author

@crazy-max crazy-max Jul 7, 2022

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/

Copy link
Contributor

@dockertopia dockertopia left a 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.

@dockertopia dockertopia self-requested a review July 12, 2022 10:06
@crazy-max crazy-max requested a review from jedevc July 19, 2022 16:40
@crazy-max

This comment was marked as outdated.

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max requested a review from usha-mandya as a code owner July 20, 2022 03:54
@crazy-max crazy-max marked this pull request as draft July 20, 2022 05:56
@crazy-max
Copy link
Member Author

moving to draft as we might create stub files so we can maintain frontmatter section here. see #15165 for more info.

Copy link
Contributor

@jedevc jedevc left a 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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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?

@crazy-max crazy-max changed the title build: add guides and bake section build: add guides Jul 23, 2022
@craig-osterhout craig-osterhout dismissed a stale review via c492b57 August 18, 2022 18:47
@docker-robott
Copy link
Collaborator

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions.
As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

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 /remove-lifecycle stale comment.
If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/build Relates to Dockerfiles or docker build command lifecycle/stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants