docs: updated Readme and cli-docs generation #5770
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
olensmar
changed the title
jfermi
reviewed
Aug 16, 2024
jfermi
reviewed
Aug 16, 2024
jfermi
reviewed
Aug 16, 2024
Co-authored-by: Julianne Fermi <[email protected]>
Co-authored-by: Julianne Fermi <[email protected]>
Co-authored-by: Julianne Fermi <[email protected]>
keevans37
approved these changes
Aug 21, 2024
rangoo94
approved these changes
Aug 21, 2024
Makefile
Outdated
| @@ -216,6 +216,7 @@ version-bump-dev: | |||
| go run cmd/tools/main.go bump --dev | |||
|
|
|||
| commands-reference: | |||
| mkdir -p docs/docs/cli | |||
There was a problem hiding this comment.
Should it be docs/docs/cli, or we should just change docs.go to a different directory, like docs/cli directly?
There was a problem hiding this comment.
thanks @rangoo94 - TBH idk - since these are temporary they should perhaps go to some /gen or /build directory? what's the go convention for this?
exu
approved these changes
Aug 22, 2024
…nto olelensmar/docs/readme-update
|
thanks @rangoo94 - does that mean I can merge? or should I wait for a resolution? |
Generally you can, but seems that we are missing @testkube-docs review for merging |
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.
Pull request description
Checklist (choose whats happened)
Breaking changes
Changes
Fixes