operator-framework / operator-framework/operator-sdk
CLI docs generation is not working well with flags deprecated
Open
@varshaprasad96 is already working on this.
Since Oct 18, 2021.
kind/bug
kind/documentation
lifecycle/frozen
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report
If we mark a command flag as deprecated the logic to generate the docs (https://github.com/operator-framework/operator-sdk/blob/master/Makefile#L42) is not adding the flag on the docs.
E.g crd-versions and webhook-versions which were flagged as deprecated
What did you do?
mark flags as deprecated and re-gen the docs
What did you expect to see?
the docs are generated with the flags deprecated and if possible with the info that they are deprecated.
What did you see instead? Under which circumstances?
the flags removed from the docs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.