build: move buildx to build section #14910
Conversation
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
crazy-max
force-pushed
the
move-buildx
branch
2 times, most recently
from
e89c921 to
f4a6136
Compare
dockertopia
left a comment
dockertopia
left a comment
There was a problem hiding this comment.
Shouldn't we combine this with the draft PR efforts in order to merge a first version of the new build section? Mostly I'm having the overview topics in mind.
On a smaller note, and on an revision level, the case use for buildx/Buildx is not consistent.
build/buildx/install.md
Outdated
| > $ chmod +x ~/.docker/cli-plugins/docker-buildx | ||
| > ``` | ||
| ## Dockerfile |
There was a problem hiding this comment.
Could we have this section above "Manual Packages"? It's such a short section, and I think putting it below the manual section means it's more likely to get missed by users (who might otherwise follow the manual installation guidelines).
There was a problem hiding this comment.
I had some high-level feedback for this PR, but I was in meetings. So, our build doc set first pages have changed since this. I think it poses a good opportunity to change some things.
So on the:
- order or pages: to keep inline "Install" types of topics follow the overview. So I would also move it up.
- structure of buildx: I think we should work on the content as if we already had the features list (simple and advanced use cases ready and you could link from there to here). So, even if, for now, they are going to be short pages. I think we make what users are trying to accomplish more discoverable by 2) Working with Buildx being only the intro (about config) and high-level options 3) promoting the sections to pages (so they show on the primary menu) 4) Check if the names of these pages are the best matches for what users would be searching.
This will allow us to 1) have the driver for content to be tasks we want to accomplish with Build/x instead of a descriptive/system pov and 2) have room to expand on each of those use cases.
So
Buildx
\ overview
\ install
\ "config"
\working with builders
\multiplatform images
There was a problem hiding this comment.
@crazy-max could we turn this into a draft for now?
There was a problem hiding this comment.
As stated in the description of this PR, this is just a move from Engine folder in manuals to Build section. Users have the same info as before so don't think it's an issue in the current state. We can ofc improve that in follow-ups.
There was a problem hiding this comment.
I can delay some work and do these changes instead today. Do you mind if I commit to the branch? Changes at structure level. Go trough content, especially install in a new PR.
There was a problem hiding this comment.
Also having many pages is not really good for navigation. We are going to have bounces and user will lost focus as scrolling is more intuitive between sections. Same on mobile where navigation is not visible.
There was a problem hiding this comment.
I don't agree. Content gets buried under in the TOC on the right-hand especially when it doesn't have the right depth. The rest of the doc sets are also moving in this direction. I really believe this move is the right move for improving discoverability and I really would like to make this changed. I'm already working on the branch. I ask that we at least look at that first.
There was a problem hiding this comment.
Can we see that in a follow-up please? This PR is only about moving buildx and preserve the current state.
There was a problem hiding this comment.
I think doing the actual content changes separately makes sense, smaller changes make for much easier reviews 😍
There was a problem hiding this comment.
That's for sure, learning that the hard way. I just had the commit all fired to go. But OK, let's do that.
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
dockertopia
left a comment
dockertopia
left a comment
There was a problem hiding this comment.
Inline: #14910 (comment)
dockertopia
left a comment
dockertopia
left a comment
There was a problem hiding this comment.
As agreed, making the proposed changes in a follow-up PR.
4 participants
follow-up #14642
Moved "Docker Buildx" section under "Docker Engine" to the new "Docker Build" section and split buildx page with an overview page and an install page. I think it makes sense to have a dedicated install page, specially for the /go redirect to install buildx.
This is just a move without any drastic changes for now. @dockertopia You can make some changes to the install page in a follow-up as you suggested to have something similar to the compose page.
Signed-off-by: CrazyMax crazy-max@users.noreply.github.com