markdown: annotation to disable docs generation for flag and command

[crazy-max]

Related to docker/docs#17539 (review)

In Buildx 0.11 we have commands for internal use only for which markdown docs should not be generated (https://github.com/docker/buildx/blame/master/docs/reference/buildx.md#L14). The new annotation docs.markdown-no-gen allows to disable docs generation for specific flag/command.

[codecov-commenter]

Codecov Report

Patch coverage: 60.00% and project coverage change: -0.25 ⚠️

Comparison is base (ce91c05) 65.61% compared to head (b0fd71e) 65.36%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #37      +/-   ##
==========================================
- Coverage   65.61%   65.36%   -0.25%     
==========================================
  Files           4        4              
  Lines         570      589      +19     
==========================================
+ Hits          374      385      +11     
- Misses        138      144       +6     
- Partials       58       60       +2     

Impacted Files	Coverage Δ
clidocstool_yaml.go	58.30% <58.33%> (+<0.01%)	⬆️
clidocstool_md.go	78.01% <62.50%> (-0.80%)	⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[dvdksn]

LGTM

[crazy-max]

@thaJeztah As discussed I removed the handling to disable docs generation for YAML as it doesn't make sense and should always be generated. Let me know if that LGTY.

[thaJeztah]

@crazy-max what was the result of looking at the hidden property? Was this special annotation still needed?

[crazy-max]

@crazy-max what was the result of looking at the hidden property? Was this special annotation still needed?

I was just misleading by the debug-shell command in buildx and thought it was hidden but it's actually not 😅. The serve command is properly hidden though but some like https://docs.docker.com/engine/reference/commandline/buildx_install/ are not:

• https://github.com/docker/buildx/blob/2eba60db75da2ea8b60b9ea2c025ff30e6c00776/commands/install.go#L50
• https://github.com/docker/docs/blob/2063af11175edd940c9421bd4279ad4e9fb26bbb/_data/buildx/docker_buildx_install.yaml#L1-L20

I will take a look at this.