Update buildx reference docs by thaJeztah · Pull Request #12092 · docker/docs

thaJeztah · 2021-01-13T16:54:13Z

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 --progress flag; https://deploy-preview-12092--docsdocker.netlify.app/engine/reference/commandline/buildx_bake/#progress

netlify · 2021-01-13T16:57:34Z

Deploy preview for docsdocker ready!

Built with commit 19ede73

https://deploy-preview-12092--docsdocker.netlify.app

thaJeztah · 2021-03-26T16:05:47Z

@usha-mandya @tonistiigi @dieucao @chris-crone ptal

thaJeztah · 2021-03-26T16:28:46Z

Pushed one more commit to update the "working with buildx" page

thaJeztah · 2021-03-27T00:44:20Z

also added the missing pages for docker buildx install and docker buildx uninstall (these commands are hidden, but were referenced in the "work with buildx" introduction

usha-mandya · 2021-03-29T18:58:52Z

@@ -33,6 +45,7 @@ options:
 - option: driver
 value_type: string
 description: 'Driver to use (available: [])'


Should we use a backtick here

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)

usha-mandya · 2021-03-29T19:03:02Z

@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 · 2021-04-07T14:18:16Z

@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)

usha-mandya

LGTM. Thank you @thaJeztah

thaJeztah · 2021-04-07T14:36:11Z

Thanks!

thaJeztah mentioned this pull request Jan 13, 2021
Split docs to separate files docker/buildx#506
Merged

thaJeztah force-pushed the buildx_reference branch 5 times, most recently from 5ac0cef to 91e6838Compare March 26, 2021 15:53

thaJeztah marked this pull request as ready for review March 26, 2021 16:03

thaJeztah force-pushed the buildx_reference branch 3 times, most recently from 7e8f1f4 to c9aaaf0Compare March 27, 2021 00:41