Skip to content

Commit 243745e

Browse files
Small improvement to docs
1 parent 6f31905 commit 243745e

File tree

6 files changed

+12
-7
lines changed

6 files changed

+12
-7
lines changed

docs/book/src/developer/providers/contracts/clusterctl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# clusterctl Provider Contract
1+
# clusterctl Provider Contract (contract version v1beta2)
22

33
The `clusterctl` command is designed to work with all the providers compliant with the following rules.
44

docs/book/src/developer/providers/contracts/control-plane.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ repo or add an item to the agenda in the [Cluster API community meeting](https:/
5555

5656
</aside>
5757

58-
## Rules (contract version v1beta1)
58+
## Rules (contract version v1beta2)
5959

6060
| Rule | Mandatory | Note |
6161
|----------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------|

docs/book/src/developer/providers/contracts/infra-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ repo or add an item to the agenda in the [Cluster API community meeting](https:/
4141

4242
</aside>
4343

44-
## Rules (contract version v1beta1)
44+
## Rules (contract version v1beta2)
4545

4646
| Rule | Mandatory | Note |
4747
|----------------------------------------------------------------------|-----------|---------------------------------------------------------------------|

docs/book/src/developer/providers/contracts/infra-machine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ repo or add an item to the agenda in the [Cluster API community meeting](https:/
4141

4242
</aside>
4343

44-
## Rules (contract version v1beta1)
44+
## Rules (contract version v1beta2)
4545

4646
| Rule | Mandatory | Note |
4747
|----------------------------------------------------------------------|-----------|--------------------------------------|

docs/book/src/developer/providers/contracts/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Those rules can be in the form of CustomResourceDefinition (CRD) fields and/or e
55

66
Different rules apply to each provider type and for each different resource that is expected to interact with "core" Cluster API.
77

8+
See [Cluster API release vs contract versions](../../../reference/versions.md#cluster-api-release-vs-contract-versions) for info about current and supported contract versions.
9+
810
- Infrastructure provider
911
- Contract rules for [InfraCluster](infra-cluster.md) resource
1012
- Contract rules for [InfraMachine](infra-machine.md) resource

docs/book/src/reference/providers.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,14 @@ As part of this effort, everyone is welcome to add to the list below both provid
66
by SIG Cluster Lifecycle as well as providers from other open-source repositories.
77

88
Each provider is the responsibility of the respective maintainers and we highly recommend
9-
everyone interested in a specific provider to engage with the corresponding team or at least
10-
to read corresponding documentation carefully.
9+
everyone interested in a specific provider to engage with the corresponding team to show support, share use cases,
10+
learn more about the other users of the same provider.
11+
12+
We also recommend to read provider's documentation carefully, test it, and perform a proper
13+
due diligence before deciding to use a provider in production, like you will do for any other open source project.
1114

1215
We are deeply thankful to all the the providers in the list, because they are a concrete proof
13-
of the liveness of the ecosystem, a relevant part of the history of this community, and a valuable
16+
of the liveness of the ecosystem, a relevant part of the history of this community, and a valuable
1417
source of inspiration and ideas for others.
1518

1619
## Bootstrap

0 commit comments

Comments
 (0)