Update examples to v1beta1 #1245
Conversation
Where v1beta1 resources exist, this updates the documentation to use these instead. The exceptions to this are: - The "introducing v1alpha2" blog post still uses v1alpha2 examples for all examples. - All GEPs are unmodified - Any examples that need to reference _some_ v1alpha2 resources, will continue to use v1alpha2 resources for all (even where v1beta1 versions exist). For example, the example in guides/tcp, the Gateway in its example is a v1alpha2 resource, as TCPRoute does not exist in v1beta1. This matches the general advice in [slack][api-advice] to continue to using the alpha API for these cases. [api-advice]: https://kubernetes.slack.com/archives/CR0H13KGA/p1656533075102939
The preferred URL schema was changed in 94b1067 to drop /v1alpha2 in the path. Some links where missed. This commit fixes those up.
Previously, all links to the API specification pointed to the v1alpha2 versions of each resource. This updates the documentation to point to v1beta1 instead. NB: guides/tcp has been explictly ignored; it will continue to point to the v1alpha2 variants, even for things like `Gateway` and `HTTPRotue`, which have graduted to v1beta1. This is because the general [advice][api-advice] is to continue to work with v1alpha2 versions if you want to support alpha-features. [api-advice]: https://kubernetes.slack.com/archives/CR0H13KGA/p1656533075102939
k8s-ci-robot
added
do-not-merge/hold
|
Hi @EmilyShepherd. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
size/L
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
|
Thanks @EmilyShepherd! /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: EmilyShepherd, robscott The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
What type of PR is this?
/kind documentation
/hold
(hold until the recommended version is >= 0.5.0)
What this PR does / why we need it:
This change was originall part of #1238, but it was agreed that updating the documentation's examples themselves should wait until 0.5.0 is the recommended version (currently it is still 0.4.x). This PR is those remaining changes which can be merged as and when they are needed.
This updates all examples to use v1beta1 variants, where possible, and links to the API Specification to use the v1beta1 versions.
It does not do any of the following:
Gateway. This is in line with the advice to continue to use v1alpha2 internally, if you want to use alpha features. (The main examples of this areguides/tcpwhich uses exclusively v1alpha2 examples, andguides/tlswhich will use v1beta1 for examples that can be impleneted using just v1beta1 resources, or v1alpha2 for examples that require the alpha Reference Grant).Does this PR introduce a user-facing change?: