Update buildx reference docs #12092
Update buildx reference docs #12092
Conversation
|
Deploy preview for docsdocker ready! Built with commit 19ede73 |
thaJeztah
force-pushed
the
buildx_reference
branch
5 times, most recently
from
5ac0cef
to
91e6838
Compare
|
Pushed one more commit to update the "working with buildx" page |
thaJeztah
force-pushed
the
buildx_reference
branch
3 times, most recently
from
7e8f1f4
to
c9aaaf0
Compare
|
also added the missing pages for |
| @@ -33,6 +45,7 @@ options: | |||
| - option: driver | |||
| value_type: string | |||
| description: 'Driver to use (available: [])' | |||
There was a problem hiding this comment.
Should we use a backtick here
There was a problem hiding this comment.
This description is coming from the generated code, and on the command-line we don't print backtics, so I'll need to have a look at this separately (we have the same issue on some of our other reference docs pages)
|
@thaJeztah Thanks for the PR. Looks good overall. Left some minor suggestions. |
The YAML files now support a new "details_url" property for flags, which can be set if there's an anchor on the same page, or an URL where to find a detailed description of the flag (Currently only anchors are used). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
these commands are hidden in the cli, but functional, and mentioned in the "working with buildx" introduction. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- remove the experimental banner - moved the "install as default builder section under the install section - wrapped lines to be ~80 chars - created some links to reference pages Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
buildx_reference
branch
from
c9aaaf0
to
19ede73
Compare
|
@usha-mandya I addressed your comments; I have a PR pending upstream with those changes (docker/buildx#583) but already regenerated the yaml files with those applied and updated this PR (so should be ready for review/merge) |
|
Thanks! |
relates to docker/buildx#91 and docker/buildx#506
This brings in more detailed command-line reference for the buildx subcommands; some enhancements were made to the template to add support for linking flag descriptions to a section on the page (or possibly an URL).
For example; the flag names in the "options" table on this page is now clickable; https://deploy-preview-12092--docsdocker.netlify.app/engine/reference/commandline/buildx_bake/#options
Which allows users to click to scroll to the relevant section on the page, for example, the section describing the
--progressflag; https://deploy-preview-12092--docsdocker.netlify.app/engine/reference/commandline/buildx_bake/#progress