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

📖 Refactor InfraCluster contract #11213

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📖 Refactor InfraCluster contract #11213

wants to merge 1 commit into from
+685 −367

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
This PR refactor the InfraCluster contract. Most notably

  • Everything related to the InfraCluster contract is now in one page, or at least in section of the book (before it was spread all around)
  • There is a table that gives an overview of all the contract rules that applies to the InfraCluster
  • Duplicated informations about the InfraCluster contract have been removed from other pages
  • (some of the work in this PR will help also speeding up the refactoring of the contract for other resources)

/area documentation

@k8s-ci-robot k8s-ci-robot added the area/documentation Issues or PRs related to documentation label Sep 20, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from fabriziopandini. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 20, 2024
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 20, 2024
vincepri
vincepri approved these changes Sep 21, 2024
View reviewed changes
Copy link
Member

@vincepri vincepri 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 Sep 21, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 4c817617634460cde9c580801062c9816128aafb

chrischdi
chrischdi reviewed Sep 23, 2024
View reviewed changes
docs/book/src/developer/providers/contracts/overview.md Show resolved Hide resolved
docs/book/src/developer/providers/best-practices.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 23, 2024
@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

sbueringer
sbueringer reviewed Sep 23, 2024
View reviewed changes
docs/book/src/developer/core/controllers/cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/core/controllers/cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/best-practices.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/best-practices.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/best-practices.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
docs/book/src/developer/providers/contracts/infra-cluster.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrischdi chrischdi chrischdi left review comments

@sbueringer sbueringer sbueringer left review comments

@jackfrancis jackfrancis Awaiting requested review from jackfrancis

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

@vincepri vincepri Awaiting requested review from vincepri

Assignees

@vincepri vincepri

Labels
area/documentation Issues or PRs related to documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@fabriziopandini @k8s-ci-robot @chrischdi @vincepri @sbueringer