cli-ref: don't show hidden commands #17631
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
crazy-max
force-pushed
the
yaml-ref-hidden-cmd
branch
from
131035c to
a090389
Compare
crazy-max
commented
Jun 27, 2023
Comment on lines
-256
to
-257
| - path: /engine/reference/commandline/buildx_install/ | ||
| title: docker buildx install |
There was a problem hiding this comment.
Needs to manually remove toc and files for hidden commands. We should generate TOC and avoid stub files in the future imo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)