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

Central Place for Annotation Documentation #3886

Closed
Smithx10 opened this issue Mar 28, 2024 · 3 comments
Closed

Central Place for Annotation Documentation #3886

Smithx10 opened this issue Mar 28, 2024 · 3 comments
Labels
documents Need documents

Comments

@Smithx10
Copy link

Kube-OVN heavily uses annotations for many functions, it would be nice if the Reference page listed all of the Kube-OVN annotations that a user can apply and what their purpose / function is.

The dependency change for an annotation to function should be clearly defined in this documentation.

Learning these patterns takes much experimentation at the moment.

I am going to attempt to write some of this in a very clear manner, but there are still annotations I don't know how to use yet.

@bobz965
Copy link
Collaborator

bobz965 commented Mar 29, 2024

Thanks, you can post a PR to the kubeovn/docs repo, we can give details about the annotations you don't know in the PR.

@oilbeater oilbeater added the documents Need documents label May 22, 2024
@oilbeater
Copy link
Collaborator

Hi, @Smithx10 are you still working on this? Most of the annotation can be found here: https://github.com/kubeovn/kube-ovn/blob/master/pkg/util/const.go. You can first write down the annotations you know, and we will supplement the explanations of other annotations based on your format.You can first write down the annotations you know, and we will supplement the explanations of other annotations based on your format.

@oilbeater
Copy link
Collaborator

Finished by kubeovn/docs#168

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documents Need documents
Projects
None yet
Development

No branches or pull requests

3 participants