Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crazy-max merged 2 commits into from
Jun 28, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27d0722
cli-ref: don't show hidden commands
crazy-max Jun 27, 2023
a090389
buildx: remove hidden commands from cli ref
crazy-max Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions _data/toc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,6 @@ reference:
title: docker buildx imagetools inspect
- path: /engine/reference/commandline/buildx_inspect/
title: docker buildx inspect
- path: /engine/reference/commandline/buildx_install/
title: docker buildx install
Comment on lines -256 to -257
Copy link
Member Author

@crazy-max crazy-max Jun 27, 2023

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.

- path: /engine/reference/commandline/buildx_ls/
title: docker buildx ls
- path: /engine/reference/commandline/buildx_prune/
Expand All @@ -263,8 +261,6 @@ reference:
title: docker buildx rm
- path: /engine/reference/commandline/buildx_stop/
title: docker buildx stop
- path: /engine/reference/commandline/buildx_uninstall/
title: docker buildx uninstall
- path: /engine/reference/commandline/buildx_use/
title: docker buildx use
- path: /engine/reference/commandline/buildx_version/
Expand Down
4 changes: 4 additions & 0 deletions _includes/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,13 @@ For example uses of this command, refer to the [examples section](#examples) bel
</thead>
<tbody>
{% for command in controller_data.cname %}
{% unless command.hidden %}
{% capture dataFileName %}{{ command | strip | replace: " ", "_" }}{% endcapture %}
<tr>
<td markdown="span">[{{ command }}]({{ parentPath }}{{ dataFileName | remove_first: "docker_" }}/)</td>
<td markdown="span">{{ site.data[include.datafolder][dataFileName].short }}</td>
</tr>
{% endunless %}
{% endfor %}
</tbody>
</table>
Expand All @@ -207,11 +209,13 @@ For example uses of this command, refer to the [examples section](#examples) bel
</thead>
<tbody>
{% for command in site.data[include.datafolder][parentdatafile].cname %}
{% unless command.hidden %}
{% capture dataFileName %}{{ command | strip | replace: " ", "_" }}{% endcapture %}
<tr>
<td markdown="span">[{{ command }}]({{ parentPath }}{{ dataFileName | remove_first: "docker_" }}/)</td>
<td markdown="span">{{ site.data[include.datafolder][dataFileName].short }}</td>
</tr>
{% endunless %}
{% endfor %}
</tbody>
</table>
Expand Down
13 changes: 0 additions & 13 deletions engine/reference/commandline/buildx_install.md
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions engine/reference/commandline/buildx_uninstall.md
View file
Open in desktop

This file was deleted.