Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

label required version for config options, and other compatibility details #2026

Open
BenTheElder opened this issue Jan 22, 2021 · 0 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@BenTheElder
Copy link
Member

What would you like to be documented:

https://kind.sigs.k8s.io/docs/user/configuration/ should surface what the minimum version of kind is for each config field, any differences in behavior, and the minimum apiVersion for the field.

The versions would probably look best as some sort of marker (table?) below each heading, but we should try some things to see what works best to effectively communicate all of this. Some of it should probably just be text within the details of the feature, renamed fields, etc.

Why is this needed:

To more clearly communicate support.


I think we should probably just start with v1alpha4, it's probably not worth it to go back and document older alphas in depth, we're not really going to support year old kind versions yet ...

@BenTheElder BenTheElder added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 22, 2021
@BenTheElder BenTheElder added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Mar 11, 2021
@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 9, 2021
@BenTheElder BenTheElder removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 23, 2021
@kubernetes-sigs kubernetes-sigs deleted a comment from fejta-bot Jun 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants