📖 Improve documentation about contract version #13134
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
k8s-ci-robot
added
size/M
chrischdi
reviewed
Dec 9, 2025
Comment on lines
2928
to
2929
| 4. If the provider implements support the [clusterctl provider contract](../contracts/clusterctl.md), also the contract version defined in the CRD | ||
| the `metadata.yaml` file must be changed. |
Member
There was a problem hiding this comment.
This sentence is a bit weird?
Suggested change
| 4. If the provider implements support the [clusterctl provider contract](../contracts/clusterctl.md), also the contract version defined in the CRD | |
| the `metadata.yaml` file must be changed. | |
| 4. If the provider implements the new [clusterctl provider contract](../contracts/clusterctl.md), then the contract version defined in the CRD | |
| and the `metadata.yaml` file must be changed. |
fabriziopandini
force-pushed
the
improve-contract-doc
branch
from
ca50cc3 to
7d3d652
Compare
lentzi90
reviewed
Dec 10, 2025
Contributor
lentzi90
left a comment
lentzi90
left a comment
There was a problem hiding this comment.
Thank you! This is looking good to me.
Honestly, the docs are not to blame for the mistake we did in CAPO, but I think it is good that this is highlighted anyway.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Follow up of a slack discussion about contract version in metadata.yam
cc @lentzi90
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 #
/area documentation