Skip to content

markdown: annotation to disable docs generation for flag and command - #37

Closed
crazy-max wants to merge 1 commit into
docker:mainfrom
crazy-max:docs-nogen
Closed

markdown: annotation to disable docs generation for flag and command#37
crazy-max wants to merge 1 commit into
docker:mainfrom
crazy-max:docs-nogen

Conversation

@crazy-max

@crazy-maxcrazy-max commented Jun 19, 2023

Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown

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 FilesCoverage Δ
clidocstool_yaml.go58.30% <58.33%> (+<0.01%)⬆️
clidocstool_md.go78.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.

@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-maxcrazy-max changed the title annotation to disable docs generation for flag and commandmarkdown: annotation to disable docs generation for flag and commandJun 27, 2023
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max

Copy link
Copy Markdown
MemberAuthor

@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

Copy link
Copy Markdown
Member

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

@crazy-max

Copy link
Copy Markdown
MemberAuthor

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

I will take a look at this.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@crazy-max@codecov-commenter@thaJeztah@dvdksn