Need v1alpha1 equivalent examples for v1alpha2

[hbagdi]

What happened:

There is not way to write examples for v1alpha2 resources.

What you expected to happen:

There should be a way to write v1alpha2 examples.

[hbagdi]

One solution that I can think of is to have a v1alpha2 directory inside the existing examples directory, copy over the existing examples, change their API versions and go from there.
We can't change the existing examples because they are referenced in docs site.

[robscott]

I made some assumptions for this in #657 where I created a new v1alpha2 directory in /examples.

[robscott]

It's possible that we should copy all examples over to that in one go, but instead I just copied them over as they changed.

[hbagdi]

Should we copy these over first in a PR and then change them as we go forward? I can send a PR if that works.
It might have happen that some never change and we might miss some of those examples, which will then later break our docs site once it switches to v1alpha2.

[robscott]

I don't have a strong opinion here, but would lean towards copying examples over as they're needed. One advantage of this approach is that we won't end up with stale examples that we never reference or use. It provides a natural way to get rid of examples from v1alpha1 that are no longer useful.

[youngnick]

I tend to agree with @robscott here, but maybe we need to add a release checklist note to review the examples and bring forward any that are still relevant?

[robscott]

maybe we need to add a release checklist note to review the examples and bring forward any that are still relevant?

Yep, that's a great idea

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[youngnick]

/lifecycle frozen

@robscott we should probably look at this one soon.

[robscott]

@youngnick Added to v1alpha2 milestone. Now that API is mostly finalized, it probably makes sense to split examples into v1alpha1 and v1alpha2 directories, and ensure that we have v1alpha2 examples to correspond with all v1alpha1 examples.

[youngnick]

Agreed. My current plan is to do exactly that - I'll move the currently-unversioned examples into a v1alpha1 directory and update the v1alpha1 guides, then we can do the v1alpha2 stuff as we get the guides and examples updated.

Additionally, I think that having the examples be in a directory each will greatly help using them in the guides, since we can include the example YAML in the guide when it's rendered.

[youngnick]

This work is complete, the examples are now split between versions, the only remaining work is to update guides and examples, which is already tracked in #783 .