build: add drivers guides #15262
build: add drivers guides #15262
Conversation
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -0,0 +1,20 @@ | |||
| --- | |||
| title: "Remote driver" | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Sure we can drop it, lgtm
There was a problem hiding this comment.
Argh if we drop this page, the index.md is not aligned 😅
There was a problem hiding this comment.
Let's keep it for now, I will change the info note to a warning one.
There was a problem hiding this comment.
Sounds good, it should get resolved quite soon, in the next bulidx release.
crazy-max
force-pushed
the
build-drivers-guide
branch
from
b8d90b4 to
17e6aa0
Compare
_data/toc.yaml
Outdated
| - path: /build/buildx/multiple-builders/ | ||
| title: Using multiple builders | ||
| - path: /build/buildx/multiplatform-images/ | ||
| - path: /build/buildx/multi-platform-images/ |
There was a problem hiding this comment.
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.
build/buildx/drivers/remote.md
Outdated
| line_end: -1 | ||
| --- | ||
|
|
||
| > Technical preview |
There was a problem hiding this comment.
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:
build/buildx/drivers/remote.md
Outdated
| line_end: -1 | ||
| --- | ||
|
|
||
| > Technical preview |
There was a problem hiding this comment.
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/.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
force-pushed
the
build-drivers-guide
branch
2 times, most recently
from
1708a4c to
0c56871
Compare
crazy-max
force-pushed
the
build-drivers-guide
branch
from
0c56871 to
83b25dc
Compare
|
@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
force-pushed
the
build-drivers-guide
branch
from
83b25dc to
a20e14b
Compare
3 participants
follow-up docker/buildx#1233
also fixed a broken link from upstream repo (buildx).
Signed-off-by: CrazyMax crazy-max@users.noreply.github.com