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.

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

Merged
merged 1 commit into from
Jul 13, 2022

Conversation

oscr
Copy link
Contributor

@oscr oscr commented Jul 6, 2022

What this PR does / why we need it:

  • Adds link to clusterctl installation in the overview to make it simpler to find.
  • Adds clusterctl upgrade plan and clusterctl upgrade apply to the commands list.
  • Adds a short description to each command.

As discussed in the issue, it does not remove the commands from the overview.

Fixes #6804

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 6, 2022
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 6, 2022
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 6, 2022
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
@oscr oscr force-pushed the clusterctl-add-desc branch from d918e8e to 5ce2829 Compare July 7, 2022 07:30
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2022
Copy link
Member

@fabriziopandini fabriziopandini left a 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?

@oscr oscr force-pushed the clusterctl-add-desc branch from 5ce2829 to f5222e1 Compare July 7, 2022 13:58
@oscr oscr requested a review from fabriziopandini July 7, 2022 13:59
@oscr
Copy link
Contributor Author

oscr commented Jul 7, 2022

@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:

* use [`clusterctl generate yaml`](commands/generate-yaml.md) to process yaml
* use [`clusterctl get kubeconfig`](commands/get-kubeconfig.md) to get the kubeconfig of an existing workload cluster.
  using clusterctl's internal yaml processor.

https://github.com/kubernetes-sigs/cluster-api/blame/main/docs/book/src/clusterctl/overview.md

Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm
@ykakarap PTAL

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 8, 2022
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/commands.md Outdated Show resolved Hide resolved
@oscr oscr force-pushed the clusterctl-add-desc branch from f5222e1 to 9416f0f Compare July 9, 2022 08:52
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 9, 2022
@oscr
Copy link
Contributor Author

oscr commented Jul 9, 2022

@ykakarap Thank you for your feedback! I have updated with your suggestions.

@oscr oscr force-pushed the clusterctl-add-desc branch from 9416f0f to c2eaa7f Compare July 12, 2022 07:08
Copy link
Contributor

@ykakarap ykakarap left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 12, 2022
@fabriziopandini
Copy link
Member

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[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 /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 Jul 13, 2022
@k8s-ci-robot k8s-ci-robot merged commit 11526d6 into kubernetes-sigs:main Jul 13, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Jul 13, 2022
@oscr oscr deleted the clusterctl-add-desc branch July 13, 2022 10:37
@sbueringer
Copy link
Member

/cherry-pick release-1.2

@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6910

In response to this:

/cherry-pick release-1.2

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.

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. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Information overlap between two clusterctl doc pages
8 participants