Refactor manifest state to use consistent arrays

bpmct · bpmct · commit c26db4876530 · 2024-10-01T16:17:29.000Z
Switch the `state` property in documentation manifest entries from
single strings to arrays across all relevant fields for consistency.
This aligns the JSON structure, allowing multiple states to be clearly
defined when necessary and ensures future flexibility in state assignments.
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -1,7 +1,5 @@
 {
-	"versions": [
-		"main"
-	],
+	"versions": ["main"],
 	"routes": [
 		{
 			"title": "About",
@@ -284,10 +282,7 @@
 					"title": "Process Logging",
 					"description": "Audit commands in workspaces with exectrace",
 					"path": "./templates/process-logging.md",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Icons",
@@ -398,30 +393,21 @@
 					"description": "Learn how to manage user groups",
 					"path": "./admin/groups.md",
 					"icon_path": "./images/icons/group.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Organizations",
 					"description": "Learn how to manage organizations",
 					"path": "./admin/organizations.md",
 					"icon_path": "./images/icons/orgs.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Template RBAC",
 					"description": "Learn how to use the role based access control against templates",
 					"path": "./admin/rbac.md",
 					"icon_path": "./images/icons/rbac.svg",
-					"state": [
-						"enterprise",
-						"beta"
-					]
+					"state": ["enterprise", "beta"]
 				},
 				{
 					"title": "Configuration",
@@ -464,20 +450,14 @@
 					"description": "Run provisioners isolated from the Coder server",
 					"path": "./admin/provisioners.md",
 					"icon_path": "./images/icons/queue.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Workspace Proxies",
 					"description": "Run geo distributed workspace proxies",
 					"path": "./admin/workspace-proxies.md",
 					"icon_path": "./images/icons/networking.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Application Logs",
@@ -490,30 +470,21 @@
 					"description": "Learn how to use Audit Logs in your Coder deployment",
 					"path": "./admin/audit-logs.md",
 					"icon_path": "./images/icons/radar.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Quotas",
 					"description": "Learn how to use Workspace Quotas in Coder",
 					"path": "./admin/quotas.md",
 					"icon_path": "./images/icons/dollar.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "High Availability",
 					"description": "Learn how to configure Coder for High Availability",
 					"path": "./admin/high-availability.md",
 					"icon_path": "./images/icons/hydra.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Prometheus",
@@ -526,10 +497,7 @@
 					"description": "Learn how to configure the appearance of Coder",
 					"path": "./admin/appearance.md",
 					"icon_path": "./images/icons/info.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Telemetry",
@@ -542,10 +510,7 @@
 					"description": "Learn how to encrypt sensitive data at rest in Coder",
 					"path": "./admin/encryption.md",
 					"icon_path": "./images/icons/lock.svg",
-					"state": [
-						"enterprise",
-						"premium"
-					]
+					"state": ["enterprise", "premium"]
 				},
 				{
 					"title": "Deployment Health",
@@ -563,13 +528,13 @@
 							"title": "Slack Notifications",
 							"description": "Learn how to setup Slack notifications",
 							"path": "./admin/notifications/slack.md",
-							"state": "beta"
+							"state": ["beta"]
 						},
 						{
 							"title": "Microsoft Teams Notifications",
 							"description": "Learn how to setup Microsoft Teams notifications",
 							"path": "./admin/notifications/teams.md",
-							"state": "beta"
+							"state": ["beta"]
 						}
 					]
 				}
diff --git a/scripts/clidocgen/main.go b/scripts/clidocgen/main.go
@@ -16,10 +16,10 @@ import (
 type route struct {
 	Title       string  `json:"title,omitempty"`
 	Description string  `json:"description,omitempty"`
-	Path        string  `json:"path,omitempty"`
-	IconPath    string  `json:"icon_path,omitempty"`
-	State       string  `json:"state,omitempty"`
-	Children    []route `json:"children,omitempty"`
+	Path        string   `json:"path,omitempty"`
+	IconPath    string   `json:"icon_path,omitempty"`
+	State       []string `json:"state,omitempty"` // Changed to []string to support an array of states
+	Children    []route  `json:"children,omitempty"`
 }
 
 // manifest describes the entire documentation index.
