Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

Discoverers: Improve command-line flags and command-line flag documentation or help text #161

Open
alexbrand opened this issue Jun 20, 2018 · 1 comment
Labels
area/documentation Issues or PRs related to documentation. discoverer priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@alexbrand
Copy link
Contributor

Some of the flags are not specific enough, while others could get a better description.

Some I have stumbled on:

  • num-threads: number of threads for what?
  • http-client-timeout: which HTTP client?

Maybe flag docs/descriptions could get a review from @Bradamant3

@alexbrand alexbrand added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. discoverer documentation labels Jun 20, 2018
@alexbrand
Copy link
Contributor Author

One consideration to keep in mind if we decide to change flags is whether we want to remain backwards compatible with previous deployment manifests.

@projectcontour-bot projectcontour-bot added area/documentation Issues or PRs related to documentation. and removed kind/documentation labels May 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/documentation Issues or PRs related to documentation. discoverer priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

No branches or pull requests

2 participants