feat: add basic docs promoting PlatformX integration

coder · bpmct · Feb 4, 2025 · Feb 1, 2025 · Feb 1, 2025 · Feb 1, 2025
commit 018938ff9147267e250b0d6ce6b0c483d5e965a7
diff --git a/docs/admin/integrations/platformx.md b/docs/admin/integrations/platformx.md
@@ -0,0 +1,28 @@
+# PlatformX by DX
+
+[DX](https://getdx.com) is a developer intelligence platform used by engineering
+leaders and platform engineers. Coder notifications can be transformed to
+[PlatformX](https://getdx.com/platformx) events, allowing platform engineers to
+measure activity and send pulse surveys to Coder users based on their
+experience.
+
+![PlatformX Events in Coder](../../images/integrations/platformx-screenshot.png)
+
+## Requirements
+
+You'll need:
+
+- A running Coder deployment
+- A PlatformX subscription from [DX](https://getdx.com/)
+- A platform to host the integration (choose any of these):
+  - AWS Lambda
+  - Heroku
+  - Kubernetes
+  - Or any other platform that can run Python web applications
+
+## Getting Started
+
+Refer to the instructions in the
+[coder-platformx-notifications](https://github.com/coder-platformx-notifications)
+repository to deploy a lightweight web server to forward Coder Notifications to
+PlatformX.
diff --git a/docs/images/integrations/platformx-screenshot.png b/docs/images/integrations/platformx-screenshot.png
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -1,5 +1,7 @@
 {
-	"versions": ["main"],
+	"versions": [
+		"main"
+	],
 	"routes": [
 		{
 			"title": "About",
@@ -200,7 +202,10 @@
 							"title": "Appearance",
 							"description": "Learn how to configure the appearance of Coder",
 							"path": "./admin/setup/appearance.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Telemetry",
@@ -281,22 +286,34 @@
 						{
 							"title": "Groups \u0026 Roles",
 							"path": "./admin/users/groups-roles.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "IdP Sync",
 							"path": "./admin/users/idp-sync.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Organizations",
 							"path": "./admin/users/organizations.md",
-							"state": ["premium", "beta"]
+							"state": [
+								"premium",
+								"beta"
+							]
 						},
 						{
 							"title": "Quotas",
 							"path": "./admin/users/quotas.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Sessions \u0026 API Tokens",
@@ -433,7 +450,10 @@
 									"title": "Process Logging",
 									"description": "Log workspace processes",
 									"path": "./admin/templates/extending-templates/process-logging.md",
-									"state": ["enterprise", "premium"]
+									"state": [
+										"enterprise",
+										"premium"
+									]
 								}
 							]
 						},
@@ -446,7 +466,10 @@
 							"title": "Permissions \u0026 Policies",
 							"description": "Learn how to create templates with Terraform",
 							"path": "./admin/templates/template-permissions.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Troubleshooting Templates",
@@ -460,7 +483,10 @@
 					"description": "Learn how to run external provisioners with Coder",
 					"path": "./admin/provisioners.md",
 					"icon_path": "./images/icons/key.svg",
-					"state": ["enterprise", "premium"]
+					"state": [
+						"enterprise",
+						"premium"
+					]
 				},
 				{
 					"title": "External Auth",
@@ -504,6 +530,11 @@
 							"description": "Integrate Coder with Island's Secure Browser",
 							"path": "./admin/integrations/island.md"
 						},
+						{
+							"title": "PlatformX by DX",
+							"description": "Integrate Coder PlatformX by getDX",
+							"path": "./admin/integrations/platformx.md"
+						},
 						{
 							"title": "Hashicorp Vault",
 							"description": "Integrate Coder with Hashicorp Vault",
@@ -531,13 +562,19 @@
 							"title": "Workspace Proxies",
 							"description": "Run geo distributed workspace proxies",
 							"path": "./admin/networking/workspace-proxies.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "High Availability",
 							"description": "Learn how to configure Coder for High Availability",
 							"path": "./admin/networking/high-availability.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Troubleshooting",
@@ -571,19 +608,25 @@
 							"title": "Notifications",
 							"description": "Configure notifications for your deployment",
 							"path": "./admin/monitoring/notifications/index.md",
-							"state": ["beta"],
+							"state": [
+								"beta"
+							],
 							"children": [
 								{
 									"title": "Slack Notifications",
 									"description": "Learn how to setup Slack notifications",
 									"path": "./admin/monitoring/notifications/slack.md",
-									"state": ["beta"]
+									"state": [
+										"beta"
+									]
 								},
 								{
 									"title": "Microsoft Teams Notifications",
 									"description": "Learn how to setup Microsoft Teams notifications",
 									"path": "./admin/monitoring/notifications/teams.md",
-									"state": ["beta"]
+									"state": [
+										"beta"
+									]
 								}
 							]
 						}
@@ -599,7 +642,10 @@
 							"title": "Audit Logs",
 							"description": "Audit actions taken inside Coder",
 							"path": "./admin/security/audit-logs.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						},
 						{
 							"title": "Secrets",
@@ -610,7 +656,10 @@
 							"title": "Database Encryption",
 							"description": "Encrypt the database to prevent unauthorized access",
 							"path": "./admin/security/database-encryption.md",
-							"state": ["enterprise", "premium"]
+							"state": [
+								"enterprise",
+								"premium"
+							]
 						}
 					]
 				},