-
Notifications
You must be signed in to change notification settings - Fork 519
First compilation of krel documentation #1201
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
Conversation
@puerco: Adding label: Reasons for blocking this PR:[Changes to certain release tools can affect our ability to test, build, and release Kubernetes. This PR must be explicitly approved by SIG Release repo admins.] Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/assign @tpepper |
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.
Just some nits, generally LGTM
11752df
to
d283cf8
Compare
Ready ! |
Great work, @puerco! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: justaugustus, puerco The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This is the firs batch of the krel documentation. Most of the subcommand docs are derived from krels help output but the idea is to have a first version of the docs from where we can improve them.
ref: #846
Special notes for your reviewer:
This is the first version of the docs. As noted above, I wrote this first batch of documents following the --help output of each subcommand. This bunch of file provides the structure to build a full featured set of documents.
If you or someone you know can provide insight to add more details, caveats, known issues or other important information please let me know.
Does this PR introduce a user-facing change?