Skip to content

build: add drivers guides - #15262

Merged
crazy-max merged 1 commit into
docker:masterfrom
crazy-max:build-drivers-guide
Jul 29, 2022
Merged

build: add drivers guides#15262
crazy-max merged 1 commit into
docker:masterfrom
crazy-max:build-drivers-guide

Conversation

@crazy-max

@crazy-maxcrazy-max commented Jul 29, 2022

Copy link
Copy Markdown
Member

follow-up docker/buildx#1233

also fixed a broken link from upstream repo (buildx).

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

@crazy-max
crazy-max requested a review from jedevcJuly 29, 2022 10:03
@netlify

netlifyBot commented Jul 29, 2022

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

NameLink
🔨 Latest commita20e14b
🔍 Latest deploy loghttps://app.netlify.com/sites/docsdocker/deploys/62e3c9bce9aa350009111dbb
😎 Deploy Previewhttps://deploy-preview-15262--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-maxcrazy-max mentioned this pull request Jul 29, 2022
@@ -0,0 +1,20 @@
---
title: "Remote driver"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with the note at the beginning noting this as a pre-release feature - but I think we should definitely try and make sure we don't do this a lot.

Could we maybe consider just dropping this page for now? Although, I'm not sure how we'd modify the index to drop it from the list.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure we can drop it, lgtm

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Argh if we drop this page, the index.md is not aligned 😅

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it for now, I will change the info note to a warning one.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, it should get resolved quite soon, in the next bulidx release.

Comment thread_data/toc.yaml Outdated
- path: /build/buildx/multiple-builders/
title: Using multiple builders
- path: /build/buildx/multiplatform-images/
- path: /build/buildx/multi-platform-images/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Multi-platform images in the title and content sounds good, but I think it helps to avoid adding an extra - in the filename. This can be clunky in the URLs and when adding xrefs from other topics. Suggest we keep this as multiplatfform-images.md in the filenames.

Comment threadbuild/buildx/drivers/remote.md Outdated
line_end: -1
---

> Technical preview

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technical preview

Remote driver is currently available as a Technical Preview.
You can build a remote driver from the upstream Buildx repository{: target="blank" rel="noopener" class=""} or use
the following command to download and install an edge release of Buildx:

Comment threadbuild/buildx/drivers/remote.md Outdated
line_end: -1
---

> Technical preview

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, should this be Beta and not Technical Preview so we are consistent with our terminology? See https://deploy-preview-14950--docsdocker.netlify.app/release-lifecycle/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah thanks yes!

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the statement, "Can be discontinued without notice" I'm not sure this is the case for the remote driver as this will still be released but not yet available.

I think we could also have "Technical preview" in this page if it makes sense:

Technical preview means a service or software that is under active development and in stages of testing. Its purpose is to establish a feedback loop, allowing customers to influence its development and direction.

But in the meantime I will use Beta terminology.

@usha-mandyausha-mandyaJul 29, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, generally, we should avoid forward-looking statements in Docs. I guess we can tag it as Beta for now and update this page to remove the Beta flag when the remote drivers feature goes GA.

@crazy-max
crazy-maxforce-pushed the build-drivers-guide branch 2 times, most recently from 1708a4c to 0c56871CompareJuly 29, 2022 11:21
@crazy-max
crazy-maxforce-pushed the build-drivers-guide branch from 0c56871 to 83b25dcCompareJuly 29, 2022 11:32
@crazy-max

crazy-max commented Jul 29, 2022

Copy link
Copy Markdown
MemberAuthor

@usha-mandya thanks for the review. Let me know if it LGTY now.

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
crazy-maxforce-pushed the build-drivers-guide branch from 83b25dc to a20e14bCompareJuly 29, 2022 11:51

@usha-mandyausha-mandya left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@crazy-max
crazy-max merged commit fcf0f9b into docker:masterJul 29, 2022
@crazy-max
crazy-max deleted the build-drivers-guide branch July 29, 2022 12:01
@crazy-maxcrazy-max added the area/build Relates to Dockerfiles or docker build command label Jul 29, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/buildRelates to Dockerfiles or docker build command

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@crazy-max@jedevc@usha-mandya