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

Annotation config.kubernetes.io/depends-on not registered / documented #42150

Open
sftim opened this issue Jul 24, 2023 · 9 comments · May be fixed by #49404
Open

Annotation config.kubernetes.io/depends-on not registered / documented #42150

sftim opened this issue Jul 24, 2023 · 9 comments · May be fixed by #49404
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@sftim
Copy link
Contributor

sftim commented Jul 24, 2023

This is a Bug Report

Problem: https://github.com/kubernetes-sigs/cli-utils/blob/master/README.md mentions an annotation, config.kubernetes.io/depends-on. We haven't documented this in https://kubernetes.io/docs/reference/labels-annotations-taints/ (which means it's not registered).

Proposed Solution:
Document that annotation.

Page to Update:
https://kubernetes.io/docs/reference/labels-annotations-taints/

Additional Information:
/language en
/sig docs

@sftim sftim added the kind/bug Categorizes issue or PR as related to a bug. label Jul 24, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 24, 2023
@AryanSharma9917
Copy link

/assign

@Shubham82
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jul 24, 2023
@sftim
Copy link
Contributor Author

sftim commented Jul 31, 2023

(anyone is welcome to work on this - we have a “no cookie licking” policy in SIG Docs)

If someone has said they plan to work on an issue, and you're also considering that work, it's polite - but not mandatory - to try to co-ordinate.

@tengqm
Copy link
Contributor

tengqm commented Oct 10, 2023

I did spend time reading materials about this annotation and the PR proposed.
However, I don't think we should add this as a "well-known labels, annotations or taints".
There are a million of annotations/labels used by external tools, but we are not supposed to document them all.

@EronWright
Copy link

A counter-point to @tengqm is that this annotation is in an official-looking domain, config.kubernetes.io.

@sftim
Copy link
Contributor Author

sftim commented Mar 14, 2024

There are a million of annotations/labels used by external tools, but we are not supposed to document them all.

The library that uses this annotation is part of the Kubernetes project.

@Ritikaa96
Copy link
Contributor

Hi, as there was still discussion on whether this annotation should be registered earlier, can we get a final note on whether working on this Issue and raising PR is required or we can close this issue?

@Ritikaa96
Copy link
Contributor

Maybe we can remove triage till the total consensus on this.
If we are open for PR , i can add this one.

@sftim
Copy link
Contributor Author

sftim commented Dec 3, 2024

Let's treat this as accepted (which is how things stand) until there's consensus to change it.

@Ritikaa96 Ritikaa96 linked a pull request Jan 13, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
7 participants