-
Notifications
You must be signed in to change notification settings - Fork 132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: updated Readme and cli-docs generation #5770
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few editing suggestions.
Co-authored-by: Julianne Fermi <[email protected]>
Co-authored-by: Julianne Fermi <[email protected]>
Co-authored-by: Julianne Fermi <[email protected]>
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
…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 |
Pull request description
Checklist (choose whats happened)
Breaking changes
Changes
Fixes