Skip to content

Commit

Permalink
docs: Add breaking changes section to introduction.md
Browse files Browse the repository at this point in the history
We want a way to call out some upcoming breaking changes for new
versions. This adds a note style callout in the
`ClusterAPI documentation versions` section.
  • Loading branch information
joekr committed Feb 23, 2023
1 parent 744f3ff commit be161fa
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/book/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ This book documents ClusterAPI v1.4. For other Cluster API versions please see t
* [release-0-4.cluster-api.sigs.k8s.io](https://release-0-4.cluster-api.sigs.k8s.io)
* [release-0-3.cluster-api.sigs.k8s.io](https://release-0-3.cluster-api.sigs.k8s.io)

> ⚠️ Break Changes ⚠️
>
> API Version v1alpha3 support will be removed with the upcoming release of v1.5
>
> API Version v1alpha4 support will be removed with the upcoming release of v1.6
>
> Review the [CONTRIBUTING support-and-guarantees](https://github.com/kubernetes-sigs/cluster-api/blob/main/CONTRIBUTING.md#support-and-guarantees) for more details
</aside>

## Why build Cluster API?
Expand Down

0 comments on commit be161fa

Please sign in to comment.