Skip to content

[WIP] Document component flags#660

Closed
irbekrm wants to merge 2 commits intocert-manager:masterfrom
irbekrm:document_component_flags
Closed

[WIP] Document component flags#660
irbekrm wants to merge 2 commits intocert-manager:masterfrom
irbekrm:document_component_flags

Conversation

@irbekrm
Copy link
Contributor

@irbekrm irbekrm commented Jul 28, 2021

Document cert-manager component flags.

The markdown files have been generated with https://github.com/jetstack/cert-manager/tree/master/tools/cobra from v1.4.0 tag.

This is the initial commit- after this gets merged, I would like to add a Prow pre-submit that PRs in an update to these files automatically (when files in cert-manager/cmd/ change).

Signed-off-by: irbekrm irbekrm@gmail.com

@jetstack-bot jetstack-bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Jul 28, 2021
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irbekrm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jetstack-bot jetstack-bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 28, 2021
@irbekrm irbekrm force-pushed the document_component_flags branch 2 times, most recently from 7543efd to b14fd57 Compare July 28, 2021 10:19
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@irbekrm

Thanks for doing this. I've often wondered how Kubernetes turn the Cobra command line help into Markdown documents.

I noticed that the menu items are duplicated in the main page and look a bit ugly

image

How about we call this "Command Line Reference" and put it alongside the API docs under a new "Reference" top-level menu item.
Not my idea, just copying the Kubernetes layout: https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/

irbekrm added 2 commits July 30, 2021 09:43
Signed-off-by: irbekrm <irbekrm@gmail.com>
Because they contain dynamically generated dates in a format that spell check doesn't accept

Signed-off-by: irbekrm <irbekrm@gmail.com>
@irbekrm irbekrm force-pushed the document_component_flags branch from b24ea1e to 14eb019 Compare July 30, 2021 08:43
@irbekrm
Copy link
Contributor Author

irbekrm commented Jul 30, 2021

Thanks @wallrj

How about we call this "Command Line Reference" and put it alongside the API docs under a new "Reference" top-level menu item.
Not my idea, just copying the Kubernetes layout: https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/

That makes sense. I will put that and the API reference docs under /Reference.
Marking this PR as WIP as I need to figure out how to generate kubectl plugin docs too cert-manager/cert-manager#4265 (comment)

@irbekrm irbekrm changed the title Document component flags [WIP] Document component flags Jul 30, 2021
@jetstack-bot jetstack-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 13, 2021
@jetstack-bot
Copy link
Contributor

@irbekrm: PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@wallrj wallrj linked an issue Jan 13, 2022 that may be closed by this pull request
@wallrj
Copy link
Member

wallrj commented Jan 27, 2022

Supplanted by #800

@wallrj wallrj closed this Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document component flags

3 participants