Skip to content

Commit 3d7bfd9

Browse files
committed
docs: add v1beta2 doc udpates + migration doc
Signed-off-by: Bharath Nallapeta <nr.bharath97@gmail.com>
1 parent 549e5ac commit 3d7bfd9

File tree

9 files changed

+6043
-27
lines changed

9 files changed

+6043
-27
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
3636

3737
| API Version | Supported Until |
3838
|--------------|-----------------------|
39-
| **v1beta1** | TBD (current stable) |
39+
| **v1beta2** | TBD (current stable) |
40+
| **v1beta1** | TBD (still served) |
4041

41-
- For the current stable API version (v1beta1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
42+
- For the current stable API version (v1beta2) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
4243
- For older API versions we only support the most recent minor release until the API version reaches EOL.
4344
- We will maintain test coverage for all supported minor releases and for one additional release for the current stable API version in case we have to do an emergency patch release.
4445
For example, if v0.11 and v0.12 are currently supported, we will also maintain test coverage for v0.10 for one additional release cycle. When v0.13 is released, tests for v0.10 will be removed.
@@ -57,10 +58,11 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
5758

5859
### Removal of v1alpha apiVersions
5960

60-
| Minor Release | v1beta1 | v1alpha7 | v1alpha6 | v1alpha5 |
61-
|---------------|---------------|------------|------------|------------|
62-
| v0.14.x | **supported** | | | |
63-
| v0.13.x | **supported** | | | |
61+
| Minor Release | v1beta2 | v1beta1 | v1alpha7 | v1alpha6 | v1alpha5 |
62+
|---------------|---------------|---------------|------------|------------|------------|
63+
| v0.15.x | **supported** | **supported** | | | |
64+
| v0.14.x | | **supported** | | | |
65+
| v0.13.x | | **supported** | | | |
6466
| v0.12.x | **supported** | not served | | |
6567
| v0.11.x | **supported** | deprecated | not served | |
6668
| v0.10.x | **supported** | supported | deprecated | not served |

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
408408
rbac:roleName=manager-role
409409

410410
.PHONY: generate-api-docs
411-
generate-api-docs: generate-api-docs-v1beta1 generate-api-docs-v1alpha1
411+
generate-api-docs: generate-api-docs-v1beta2 generate-api-docs-v1beta1 generate-api-docs-v1alpha1
412412
generate-api-docs-%: $(GEN_CRD_API_REFERENCE_DOCS) FORCE
413413
$(GEN_CRD_API_REFERENCE_DOCS) \
414414
-api-dir=./api/$* \

docs/book/gen-crd-api-reference-docs/config.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
{
2727
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta1",
2828
"docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta1/api#infrastructure.cluster.x-k8s.io/v1beta1.{{.TypeIdentifier}}"
29+
},
30+
{
31+
"typeMatchPrefix": "^sigs\\.k8s\\.io/cluster-api-provider-openstack/api/v1beta2",
32+
"docsURLTemplate": "https://cluster-api-openstack.sigs.k8s.io/api/v1beta2/api#infrastructure.cluster.x-k8s.io/v1beta2.{{.TypeIdentifier}}"
2933
}
3034
],
3135
"typeDisplayNamePrefixOverrides": {

docs/book/src/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@
1717
- [v1alpha5 to v1alpha6](./topics/crd-changes/v1alpha5-to-v1alpha6.md)
1818
- [v1alpha6 to v1alpha7](./topics/crd-changes/v1alpha6-to-v1alpha7.md)
1919
- [v1alpha7 to v1beta1](./topics/crd-changes/v1alpha7-to-v1beta1.md)
20+
- [v1beta1 to v1beta2](./topics/crd-changes/v1beta1-to-v1beta2.md)
2021
- [API reference](./api/index.md)
2122
- [v1alpha1](./api/v1alpha1/api.md)
2223
- [v1beta1](./api/v1beta1/api.md)
24+
- [v1beta2](./api/v1beta2/api.md)
2325
- [Development](./development/development.md)
2426
- [Hacking CI](./development/ci.md)

0 commit comments

Comments
 (0)