Skip to content
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

Jump to bottom

Automatically generate the list of flags in the documentation #162

Open
mlavacca opened this issue Jun 13, 2024 · 4 comments
Open

Automatically generate the list of flags in the documentation #162

mlavacca opened this issue Jun 13, 2024 · 4 comments
Assignees
@omerap12
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@mlavacca
Copy link
Member

What would you like to be added:

We have a list of flags in our README that needs to be manually updated every time a flag gets added, removed, or changed. We may want to automatically generate such a list of flags to avoid misalignment between the actual flags and our docs

/kind documentation
@mlavacca mlavacca added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 13, 2024
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 13, 2024
@mlavacca mlavacca added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed kind/documentation Categorizes issue or PR as related to documentation. labels Jun 13, 2024
@mlavacca
Copy link
Member Author

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 13, 2024
@LiorLieberman
Copy link
Member

SGTM!
/triage accepted

@k8s-ci-robot k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Jun 13, 2024
@levikobi
Copy link
Member

Sounds great👍🏻

@mlavacca mlavacca added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 17, 2024
@omerap12
Copy link
Member

omerap12 commented Jul 5, 2024

/assign

@omerap12 omerap12 mentioned this issue Jul 5, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@omerap12 omerap12

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@k8s-ci-robot @mlavacca @levikobi @omerap12 @LiorLieberman