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

[META] document all operator-framework object annotations per project #122

Open
estroz opened this issue May 26, 2021 · 0 comments
Open
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@estroz
Copy link
Member

estroz commented May 26, 2021

This idea recently came up, and I figured the api repo is the best place to document org-wide annotations. There really should be some authoritative list of these annotations, which are currently (maybe) documented by the projects that use them, ex. the set of Operator SDK plugin names, helm-operator annotations, etc.

Suggested structure: docs/annotations/<repo or project or component>.md with a list of each annotation and description:

- key: operatorframework.io/paused
  key-format: <optional string for formatted keys, an alternative to "key">
  values: ["true", "True"]
  value-format: <optional string for formatted values, an alternative to "values">
  owner: https://github.com/operator-framework/operator-lib <!-- some owner link -->
  refs: ["predicate", "handler"] <!-- list of subpackages, files, etc -->
  description: |
	A long-form description of the annotation. Should be fairly all-encompassing if set.
  description-link: <optional link to a description, an alternative to "description">

/kind documentation
/priority important-longterm

@openshift-ci openshift-ci bot added kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

No branches or pull requests

1 participant