-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
📖 Add short description for each clusterctl command in CAPI book #6839
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.
/lgtm
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.
What about wrapping the list of commands in the overview page with:
Below you can find a list of main clusterctl commands:
...
For the full list of clusterctl commands please refer to [lin to the command page].
Also can we align description in overview to the one proposed in clusterctl commands?
@fabriziopandini I have added your suggestions and aligned the descriptions. It was a great suggestion to align and I noticed a mistake that's been there for 2 years that I didn't see before:
|
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.
/lgtm
@ykakarap PTAL
@ykakarap Thank you for your feedback! I have updated with your suggestions. |
9416f0f
to
c2eaa7f
Compare
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.
/lgtm
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini 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 |
/cherry-pick release-1.2 |
@sbueringer: new pull request created: #6910 In response to this:
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. |
What this PR does / why we need it:
clusterctl upgrade plan
andclusterctl upgrade apply
to the commands list.As discussed in the issue, it does not remove the commands from the overview.
Fixes #6804