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

📖 documentation for clusterctl alpha topology plan #6009

Merged

Conversation

ykakarap
Copy link
Contributor

What this PR does / why we need it:

Adds documentation for the new clusterctl alpha topology plan command.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@ykakarap ykakarap changed the title 📖 topology plan command doc 📖 [WIP]topology plan command doc Jan 27, 2022
@k8s-ci-robot k8s-ci-robot added 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 Jan 27, 2022
@ykakarap ykakarap changed the title 📖 [WIP]topology plan command doc 📖 [WIP] topology plan command doc Jan 27, 2022
@ykakarap ykakarap changed the title 📖 [WIP] topology plan command doc 📖 [WIP] documentation for clusterctl alpha topology plan Jan 27, 2022
@ykakarap ykakarap force-pushed the clusterctl_topology_plan_doc branch from 53ecf8d to b6a44fa Compare January 27, 2022 14:55
@sbueringer
Copy link
Member

xref: #5953

Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Looks good to me!

One potential additional use case could be modifying something in the Cluster topology while the ClusterClass stays the same

docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
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.

That a great start!
Main comments

  • let's drop dry run and use plan
  • let's move Reference at the end (as well as the notes about corners cases/details)
  • let's add two use cases
    • change topology
    • rebase

docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
@ykakarap ykakarap force-pushed the clusterctl_topology_plan_doc branch from b6a44fa to 81fe29c Compare January 28, 2022 12:43
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.

This looks great!
last round of nits from my side (and you can remove WIP as well)

docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
docs/book/src/clusterctl/commands/alpha-topology-plan.md Outdated Show resolved Hide resolved
@ykakarap ykakarap changed the title 📖 [WIP] documentation for clusterctl alpha topology plan 📖 documentation for clusterctl alpha topology plan Jan 28, 2022
@ykakarap ykakarap force-pushed the clusterctl_topology_plan_doc branch from 81fe29c to 364fdcb Compare January 28, 2022 14:21
@fabriziopandini
Copy link
Member

/lgtm
@sbueringer PTAL

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 28, 2022
@ykakarap ykakarap force-pushed the clusterctl_topology_plan_doc branch from 364fdcb to 390251a Compare January 28, 2022 14:48
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 28, 2022
@sbueringer
Copy link
Member

sbueringer commented Jan 28, 2022

Thx, great work! I think it explains very nicely what you can achieve with the topology plan command

/lgtm

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

/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 Jan 31, 2022
@k8s-ci-robot k8s-ci-robot merged commit 943cf23 into kubernetes-sigs:main Jan 31, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Jan 31, 2022
@fabriziopandini
Copy link
Member

/cherry-pick release-1.1

@k8s-infra-cherrypick-robot

@fabriziopandini: new pull request created: #6023

In response to this:

/cherry-pick release-1.1

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/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