Navigation: remove description from the backend navmodel and use subTitle instead (#56155)

* remove description from the backend navmodel and use subTitle instead * only add admin subtitle in topnav
2022-10-03 10:09:32 +01:00
parent f7de253cdd
commit 3e688ecf7d
7 changed files with 149 additions and 152 deletions
@@ -18,62 +18,62 @@ func (s *ServiceImpl) getOrgAdminNode(c *models.ReqContext) (*navtree.NavLink, e
 	hasAccess := ac.HasAccess(s.accessControl, c)
 	if hasAccess(ac.ReqOrgAdmin, datasources.ConfigurationPageAccess) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Data sources",
-			Icon:        "database",
-			Description: "Add and configure data sources",
-			Id:          "datasources",
-			Url:         s.cfg.AppSubURL + "/datasources",
+			Text:     "Data sources",
+			Icon:     "database",
+			SubTitle: "Add and configure data sources",
+			Id:       "datasources",
+			Url:      s.cfg.AppSubURL + "/datasources",
 		})
 	}

 	if s.features.IsEnabled(featuremgmt.FlagCorrelations) && hasAccess(ac.ReqOrgAdmin, correlations.ConfigurationPageAccess) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Correlations",
-			Icon:        "gf-glue",
-			Description: "Add and configure correlations",
-			Id:          "correlations",
-			Url:         s.cfg.AppSubURL + "/datasources/correlations",
+			Text:     "Correlations",
+			Icon:     "gf-glue",
+			SubTitle: "Add and configure correlations",
+			Id:       "correlations",
+			Url:      s.cfg.AppSubURL + "/datasources/correlations",
 		})
 	}

 	if hasAccess(ac.ReqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Users",
-			Id:          "users",
-			Description: "Invite and assign roles to users",
-			Icon:        "user",
-			Url:         s.cfg.AppSubURL + "/org/users",
+			Text:     "Users",
+			Id:       "users",
+			SubTitle: "Invite and assign roles to users",
+			Icon:     "user",
+			Url:      s.cfg.AppSubURL + "/org/users",
 		})
 	}

 	if hasAccess(s.ReqCanAdminTeams, ac.TeamsAccessEvaluator) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Teams",
-			Id:          "teams",
-			Description: "Groups of users that have common dashboard and permission needs",
-			Icon:        "users-alt",
-			Url:         s.cfg.AppSubURL + "/org/teams",
+			Text:     "Teams",
+			Id:       "teams",
+			SubTitle: "Groups of users that have common dashboard and permission needs",
+			Icon:     "users-alt",
+			Url:      s.cfg.AppSubURL + "/org/teams",
 		})
 	}

 	// FIXME: while we don't have a permissions for listing plugins the legacy check has to stay as a default
 	if plugins.ReqCanAdminPlugins(s.cfg)(c) || hasAccess(plugins.ReqCanAdminPlugins(s.cfg), plugins.AdminAccessEvaluator) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Plugins",
-			Id:          "plugins",
-			Description: "Extend the Grafana experience with plugins",
-			Icon:        "plug",
-			Url:         s.cfg.AppSubURL + "/plugins",
+			Text:     "Plugins",
+			Id:       "plugins",
+			SubTitle: "Extend the Grafana experience with plugins",
+			Icon:     "plug",
+			Url:      s.cfg.AppSubURL + "/plugins",
 		})
 	}

 	if hasAccess(ac.ReqOrgAdmin, ac.OrgPreferencesAccessEvaluator) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Preferences",
-			Id:          "org-settings",
-			Description: "Manage preferences across an organization",
-			Icon:        "sliders-v-alt",
-			Url:         s.cfg.AppSubURL + "/org",
+			Text:     "Preferences",
+			Id:       "org-settings",
+			SubTitle: "Manage preferences across an organization",
+			Icon:     "sliders-v-alt",
+			Url:      s.cfg.AppSubURL + "/org",
 		})
 	}

@@ -86,21 +86,21 @@ func (s *ServiceImpl) getOrgAdminNode(c *models.ReqContext) (*navtree.NavLink, e
 	apiKeysHidden := hideApiKeys == "1" && len(apiKeys) == 0
 	if hasAccess(ac.ReqOrgAdmin, ac.ApiKeyAccessEvaluator) && !apiKeysHidden {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "API keys",
-			Id:          "apikeys",
-			Description: "Manage and create API keys that are used to interact with Grafana HTTP APIs",
-			Icon:        "key-skeleton-alt",
-			Url:         s.cfg.AppSubURL + "/org/apikeys",
+			Text:     "API keys",
+			Id:       "apikeys",
+			SubTitle: "Manage and create API keys that are used to interact with Grafana HTTP APIs",
+			Icon:     "key-skeleton-alt",
+			Url:      s.cfg.AppSubURL + "/org/apikeys",
 		})
 	}

 	if enableServiceAccount(s, c) {
 		configNodes = append(configNodes, &navtree.NavLink{
-			Text:        "Service accounts",
-			Id:          "serviceaccounts",
-			Description: "Use service accounts to run automated workloads in Grafana",
-			Icon:        "gf-service-account",
-			Url:         s.cfg.AppSubURL + "/org/serviceaccounts",
+			Text:     "Service accounts",
+			Id:       "serviceaccounts",
+			SubTitle: "Use service accounts to run automated workloads in Grafana",
+			Icon:     "gf-service-account",
+			Url:      s.cfg.AppSubURL + "/org/serviceaccounts",
 		})
 	}

@@ -125,29 +125,29 @@ func (s *ServiceImpl) getServerAdminNode(c *models.ReqContext) *navtree.NavLink

 	if hasAccess(ac.ReqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, ac.ScopeGlobalUsersAll)) {
 		adminNavLinks = append(adminNavLinks, &navtree.NavLink{
-			Text: "Users", Description: "Manage and create users across the whole Grafana server", Id: "global-users", Url: s.cfg.AppSubURL + "/admin/users", Icon: "user",
+			Text: "Users", SubTitle: "Manage and create users across the whole Grafana server", Id: "global-users", Url: s.cfg.AppSubURL + "/admin/users", Icon: "user",
 		})
 	}

 	if hasGlobalAccess(ac.ReqGrafanaAdmin, orgsAccessEvaluator) {
 		adminNavLinks = append(adminNavLinks, &navtree.NavLink{
-			Text: "Organizations", Description: "Isolated instances of Grafana running on the same server", Id: "global-orgs", Url: s.cfg.AppSubURL + "/admin/orgs", Icon: "building",
+			Text: "Organizations", SubTitle: "Isolated instances of Grafana running on the same server", Id: "global-orgs", Url: s.cfg.AppSubURL + "/admin/orgs", Icon: "building",
 		})
 	}

 	if hasAccess(ac.ReqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)) {
 		adminNavLinks = append(adminNavLinks, &navtree.NavLink{
-			Text: "Settings", Description: "View the settings defined in your Grafana config", Id: "server-settings", Url: s.cfg.AppSubURL + "/admin/settings", Icon: "sliders-v-alt",
+			Text: "Settings", SubTitle: "View the settings defined in your Grafana config", Id: "server-settings", Url: s.cfg.AppSubURL + "/admin/settings", Icon: "sliders-v-alt",
 		})
 	}

 	if hasAccess(ac.ReqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)) && s.features.IsEnabled(featuremgmt.FlagStorage) {
 		adminNavLinks = append(adminNavLinks, &navtree.NavLink{
-			Text:        "Storage",
-			Id:          "storage",
-			Description: "Manage file storage",
-			Icon:        "cube",
-			Url:         s.cfg.AppSubURL + "/admin/storage",
+			Text:     "Storage",
+			Id:       "storage",
+			SubTitle: "Manage file storage",
+			Icon:     "cube",
+			Url:      s.cfg.AppSubURL + "/admin/storage",
 		})
 	}

@@ -158,13 +158,16 @@ func (s *ServiceImpl) getServerAdminNode(c *models.ReqContext) *navtree.NavLink
 	}

 	adminNode := &navtree.NavLink{
-		Text:        "Server admin",
-		Description: "Manage server-wide settings and access to resources such as organizations, users, and licenses",
-		Id:          navtree.NavIDAdmin,
-		Icon:        "shield",
-		SortWeight:  navtree.WeightAdmin,
-		Section:     navtree.NavSectionConfig,
-		Children:    adminNavLinks,
+		Text:       "Server admin",
+		Id:         navtree.NavIDAdmin,
+		Icon:       "shield",
+		SortWeight: navtree.WeightAdmin,
+		Section:    navtree.NavSectionConfig,
+		Children:   adminNavLinks,
+	}
+
+	if s.cfg.IsFeatureToggleEnabled(featuremgmt.FlagTopnav) {
+		adminNode.SubTitle = "Manage server-wide settings and access to resources such as organizations, users, and licenses"
 	}

 	if len(adminNavLinks) > 0 {