Skip to content

delete the flags reference from docs and point to flag defs directly instead #880

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.

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

Closed
mflendrich opened this issue Sep 29, 2020 · 2 comments

Comments

@mflendrich
Copy link
Contributor

cli-arguments.md is a verbatim copy of pflag flag definitions present in the code. pflag takes care of pretty-printing an equivalent of the flags table in cli-arguments.md.

The scope of this issue is to de-duplicate the flag reference, and point users to either --help, or flag definitions in the code.

@rainest
Copy link
Contributor

rainest commented Jan 21, 2021

I propose we drop this and continue maintaining the document. Users don't typically have a standalone controller binary and changing the container args to --help and checking logs or execing the container locally is a bit clunky and unintuitive. We shouldn't expect users to review code, even if it's relatively straightforward--it's out of line with how users typically interact with the controller and doesn't align with how we document the rest of it.

@stale
Copy link

stale bot commented Mar 20, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 20, 2021
@stale stale bot closed this as completed Mar 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants