Skip to content

cli-ref: don't show hidden commands - #17631

Merged
crazy-max merged 2 commits into
docker:mainfrom
crazy-max:yaml-ref-hidden-cmd
Jun 28, 2023
Merged

cli-ref: don't show hidden commands#17631
crazy-max merged 2 commits into
docker:mainfrom
crazy-max:yaml-ref-hidden-cmd

Conversation

@crazy-max

Copy link
Copy Markdown
Member

Proposed changes

As discussed in docker/cli-docs-tool#37 (comment), we should not show hidden commands.

This will be supported in buildx once docker/buildx#1918 is merged. To add support for this in cli or other plugins, they should update cli-docs-tool to latest 0.6.0: https://github.com/docker/cli-docs-tool/releases/tag/v0.6.0

Related issues (optional)

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

netlifyBot commented Jun 27, 2023

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

NameLink
🔨 Latest commita090389
🔍 Latest deploy loghttps://app.netlify.com/sites/docsdocker/deploys/649b22b92f70660008c9d207
😎 Deploy Previewhttps://deploy-preview-17631--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 configuration.

@crazy-maxcrazy-max added the area/cli Relates to the CLI client label Jun 27, 2023
@crazy-max
crazy-max marked this pull request as ready for review June 27, 2023 17:55
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
crazy-maxforce-pushed the yaml-ref-hidden-cmd branch from 131035c to a090389CompareJune 27, 2023 17:56
Comment thread_data/toc.yaml
Comment on lines -256 to -257
- path: /engine/reference/commandline/buildx_install/
title: docker buildx install

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.

Needs to manually remove toc and files for hidden commands. We should generate TOC and avoid stub files in the future imo.

@dvdksndvdksn left a comment

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.

LGTM

@crazy-max
crazy-max merged commit 42930be into docker:mainJun 28, 2023
@crazy-max
crazy-max deleted the yaml-ref-hidden-cmd branch July 3, 2023 10:54
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/cliRelates to the CLI client

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@crazy-max@dvdksn