Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix mis-typing in CLI command documentations #5854

Merged
merged 1 commit into from
Oct 9, 2018
Merged

Fix mis-typing in CLI command documentations #5854

merged 1 commit into from
Oct 9, 2018

Conversation

posquit0
Copy link
Contributor

@posquit0 posquit0 commented Oct 1, 2018

I found some mis-typed documentations in CLI.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 1, 2018
@rdrgmnzs
Copy link
Contributor

rdrgmnzs commented Oct 3, 2018

@posquit0 would you mind also updating cmd/kops/validate.go as that is how these docs get generated based on. Thank you so much for the PR,

@posquit0
Copy link
Contributor Author

posquit0 commented Oct 3, 2018

@rdrgmnzs I fixed. Thanks to let me know!

@mikesplain
Copy link
Contributor

Hi @posquit0 do you mind squashing all this into a single commit? We don't have the ability to do that on merge so we prefer all related content in a given commit. Thanks!

/ok-to-test

@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 3, 2018
@posquit0
Copy link
Contributor Author

posquit0 commented Oct 3, 2018

Sorry. I squashed all commits to a single one. 👍

justinsb
justinsb reviewed Oct 3, 2018
View reviewed changes
cmd/kops/validate.go Outdated
@@ -31,7 +31,7 @@ var (

1. All k8s masters are running and have "Ready" status.
2. All k8s nodes are running and have "Ready" status.
3. Componentstatues returns healthy for all components.
3. Component statues returns healthy for all components.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a typo in the original (as well as the missing space) - it should be "Component status returns healthy..."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed again. good!

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 3, 2018
@rdrgmnzs
Copy link
Contributor

rdrgmnzs commented Oct 3, 2018

@posquit0 sorry one more thing. Could you run make gen-cli-docs it looks like removing the spaces at the end of the lines may be making our CI process fail. Those .md files are auto generated so the spaces being there are due to the doc generation mechanism.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 4, 2018
@posquit0
Copy link
Contributor Author

posquit0 commented Oct 4, 2018

Sorry, my editor is configured to strip all trailing spaces on saving file. I restored trailing spaces.
Thanks!

@posquit0
Copy link
Contributor Author

posquit0 commented Oct 6, 2018

Please check this again :)

@justinsb
Copy link
Member

justinsb commented Oct 9, 2018

Wonderful - thank you @posquit0

/approve
/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: justinsb, posquit0

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 Oct 9, 2018
@k8s-ci-robot k8s-ci-robot merged commit 87808fb into kubernetes:master Oct 9, 2018
@posquit0 posquit0 deleted the patch-2 branch October 9, 2018 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justinsb justinsb justinsb left review comments

@chrisz100 chrisz100 Awaiting requested review from chrisz100

@robinpercy robinpercy Awaiting requested review from robinpercy

Assignees

@justinsb justinsb

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@posquit0 @rdrgmnzs @mikesplain @justinsb @k8s-ci-robot