Schemas: Add description to kinds metadata (#62638)

* add description to kinds

* omit empty

kinds/dashboard/dashboard_kind.cue

@@ -2,8 +2,9 @@ package kind
 
 import "strings"
 
-name:     "Dashboard"
+name:        "Dashboard"
-maturity: "experimental"
+maturity:    "experimental"
+description: "A Grafana dashboard."
 
 lineage: seqs: [
 	{

kinds/librarypanel/librarypanel_kind.cue

@@ -2,8 +2,9 @@ package kind
 
 import "strings"
 
-name:     "LibraryPanel"
+name:        "LibraryPanel"
-maturity: "experimental"
+maturity:    "experimental"
+description: "A standalone panel"
 
 lineage: seqs: [
 	{

kinds/playlist/playlist_kind.cue

@@ -1,7 +1,8 @@
 package kind
 
-name:     "Playlist"
+name:        "Playlist"
-maturity: "merged"
+maturity:    "merged"
+description: "A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval."
 
 lineage: seqs: [
 	{

kinds/preferences/preferences_kind.cue

@@ -1,7 +1,8 @@
 package kind
 
-name:     "Preferences"
+name:        "Preferences"
-maturity: "merged"
+maturity:    "merged"
+description: "The user or team frontend preferences"
 
 lineage: seqs: [
 	{

kinds/publicdashboard/public_dashboard_kind.cue

@@ -1,7 +1,8 @@
 package kind
 
-name:     "PublicDashboard"
+name:        "PublicDashboard"
-maturity: "merged"
+maturity:    "merged"
+description: "Public dashboard configuration"
 
 lineage: seqs: [
 	{

kinds/serviceaccount/serviceaccount_kind.cue

@@ -1,7 +1,8 @@
 package kind
 
-name:     "ServiceAccount"
+name:        "ServiceAccount"
-maturity: "merged"
+maturity:    "merged"
+description: "system account"
 
 lineage: seqs: [
 	{

kinds/team/team_kind.cue

@@ -1,7 +1,8 @@
 package kind
 
-name:     "Team"
+name:        "Team"
-maturity: "merged"
+maturity:    "merged"
+description: "A team is a named grouping of Grafana users to which access control rules may be assigned."
 
 lineage: seqs: [
 	{

pkg/kindsys/kindcats.cue

@@ -79,6 +79,14 @@ _sharedKind: {
 	maturity: *"merged" | "experimental"
 }
 
+// properties shared by all kinds that represent a complete object from root (i.e., not composable)
+_rootKind: {
+	// description is a brief narrative description of the nature and purpose of the kind.
+	// The contents of this field is shown to end users. Prefer clear, concise wording
+	// with minimal jargon.
+	description: nonEmptyString
+}
+
 // Maturity indicates the how far a given kind definition is in its initial
 // journey. Mature kinds still evolve, but with guarantees about compatibility.
 Maturity: "merged" | "experimental" | "stable" | "mature"
@@ -88,7 +96,10 @@ Maturity: "merged" | "experimental" | "stable" | "mature"
 // and datasources, are represented as core kinds.
 Core: S=close({
 	_sharedKind
+	_rootKind
 
 	lineage: { name: S.machineName }
 	lineageIsGroup: false
 })
+
+nonEmptyString: string & strings.MinRunes(1)

pkg/kindsys/props.go

@@ -10,6 +10,7 @@ type CommonProperties struct {
 	PluralMachineName string   `json:"pluralMachineName"`
 	LineageIsGroup    bool     `json:"lineageIsGroup"`
 	Maturity          Maturity `json:"maturity"`
+	Description       string   `json:"description,omitempty"`
 }
 
 // CoreProperties represents the static properties in the definition of a

pkg/kindsys/report.json

@@ -283,6 +283,7 @@
         0,
         0
       ],
+      "description": "A Grafana dashboard.",
       "grafanaMaturityCount": 139,
       "lineageIsGroup": false,
       "links": {
@@ -819,6 +820,7 @@
         0,
         0
       ],
+      "description": "A standalone panel",
       "grafanaMaturityCount": 10,
       "lineageIsGroup": false,
       "links": {
@@ -1181,6 +1183,7 @@
         0,
         0
       ],
+      "description": "A playlist is a series of dashboards that is automatically rotated in the browser, on a configurable interval.",
       "grafanaMaturityCount": 0,
       "lineageIsGroup": false,
       "links": {
@@ -1251,6 +1254,7 @@
         0,
         0
       ],
+      "description": "The user or team frontend preferences",
       "grafanaMaturityCount": 0,
       "lineageIsGroup": false,
       "links": {
@@ -1321,6 +1325,7 @@
         0,
         0
       ],
+      "description": "Public dashboard configuration",
       "grafanaMaturityCount": 0,
       "lineageIsGroup": false,
       "links": {
@@ -1389,6 +1394,7 @@
         0,
         0
       ],
+      "description": "system account",
       "grafanaMaturityCount": 9,
       "lineageIsGroup": false,
       "links": {
@@ -1509,6 +1515,7 @@
         0,
         0
       ],
+      "description": "A team is a named grouping of Grafana users to which access control rules may be assigned.",
       "grafanaMaturityCount": 7,
       "lineageIsGroup": false,
       "links": {