github.com/giantswarm/apiextensions/v6@v6.6.0/pkg/annotation/general.go (about)

     1  // Package annotation defines annotation keys used by Giant Swarm within
     2  // Kubernetes resources.
     3  package annotation
     4  
     5  // Docs is the docs annotation put into all CRs to link to its CR specific
     6  // documentation. This aims to help understanding all the moving parts within
     7  // the system and how they relate to each other.
     8  const Docs = "giantswarm.io/docs"
     9  
    10  // Notes is for informational messages for resources managed by operators. Such
    11  // as whether the resource may or may not be edited.
    12  const Notes = "giantswarm.io/notes"
    13  
    14  // ReleaseNotesURL defines where to find release notes about the CR at hand.
    15  // The value is expected to be a URI, e. g.
    16  // "https://docs.giantswarm.io/changes/workload-cluster-releases-aws/releases/aws-v11.5.0/".
    17  const ReleaseNotesURL = "giantswarm.io/release-notes"