feat(*) add reference documentation generator #2140
Merged
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
Add tooling to generate CLI reference documentation to the path named in "$DESTDIR". The goal is for the website to generate reference docs on each new version. This updates kumahq/kuma-website#447. Signed-off-by: James Peach <james.peach@konghq.com>
|
looks good. I will rebase this on #2101 once this is merged and update the man pages section. |
Signed-off-by: James Peach <james.peach@konghq.com>
Per discussion in kuma-website#447, generate the command documentation locally (as a side-effect of `make check`). Signed-off-by: James Peach <james.peach@konghq.com>
If we allow cobra to emit the timestamp on the generated docs, then they change every time we run `make check`, which is undesirable. Signed-off-by: James Peach <james.peach@konghq.com>
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.
Summary
Add tooling to generate CLI reference documentation to the path named
in "$DESTDIR". The goal is for the website to generate reference docs
on each new version.
This updates kumahq/kuma-website#447.
Full changelog
Issues resolved
N/A
Documentation
N/A
Testing
Manual testing.