feat: add CLI args docs generator #34
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pmalek
force-pushed
the
add-cli-args-generator
branch
from
7390dcf
to
84a2a9e
Compare
|
Implemented in EE because its flags are a superset of this repo's flags. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR adds
generate.cli-arguments-docsmakefile target which takes the flags from https://github.com/Kong/gateway-operator/blob/7390dcf2e1cebb7eb08c4c1f8af0e3a084423034/modules/cli/cli.go and generates markdown table based on that.#35 tracks the automation effort of that.
The included script:
./scripts/cli-arguments-docs-gen/post-process-for-konghq.shadopts the docs to docs.konghq.com format.