Skip to content

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

Merged
merged 1 commit into from
Mar 21, 2020

Conversation

puerco
Copy link
Member

@puerco puerco commented Mar 20, 2020

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?

First batch of krel usage documents. Main README.md and a doc for each subcommand.

@k8s-ci-robot
Copy link
Contributor

@puerco: Adding label: do-not-merge/blocked-paths because PR changes a protected file.

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.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/blocked-paths Indicates that a PR should not merge because it touches files in blocked paths. kind/documentation Categorizes issue or PR as related to documentation. needs-priority cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 20, 2020
@k8s-ci-robot k8s-ci-robot added area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. labels Mar 20, 2020
@puerco
Copy link
Member Author

puerco commented Mar 20, 2020

/assign @tpepper

Copy link
Member

@saschagrunert saschagrunert left a 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

@puerco puerco force-pushed the krel-documentation branch from 11752df to d283cf8 Compare March 20, 2020 17:03
@puerco
Copy link
Member Author

puerco commented Mar 20, 2020

Ready !

@justaugustus justaugustus removed the do-not-merge/blocked-paths Indicates that a PR should not merge because it touches files in blocked paths. label Mar 21, 2020
@justaugustus
Copy link
Member

Great work, @puerco!
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2020
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 21, 2020
@k8s-ci-robot k8s-ci-robot merged commit 3e3e14a into kubernetes:master Mar 21, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.19 milestone Mar 21, 2020
@puerco puerco deleted the krel-documentation branch May 13, 2020 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants