Add licensing and groups documentation

matifali · matifali · commit f709b8e892d9 · 2024-10-03T15:04:13.000Z
- Introduce a Licensing section to detail feature access with licenses.
- Document the Groups feature for user access management in templates.
- Update the manifest to include the new documentation sections.
diff --git a/docs/admin/licensing/README.md b/docs/admin/licensing/README.md
@@ -0,0 +1,47 @@
+# Licensing
+
+Some features are only accessible with a Premium or Enterprise license. See our
+[pricing page](https://coder.com/pricing) for more details. To try Premium
+features, you can [request a trial](https://coder.com/trial) or
+[contact sales](https://coder.com/contact).
+
+<!-- markdown-link-check-disable -->
+
+> If you are an existing customer, you can learn more our new Premium plan in
+> the [Coder v2.16 blog post](https://coder.com/blog/release-recap-2-16-0)
+
+<!-- markdown-link-check-enable -->
+
+## Adding your license key
+
+There are two ways to add a license to a Coder deployment:
+
+<div class="tabs">
+
+### Coder UI
+
+First, ensure you have a license key
+([request a trial](https://coder.com/trial)).
+
+With an `Owner` account, navigate to `Deployment -> Licenses`, `Add a license`
+then drag or select the license file with the `jwt` extension.
+
+![Add License UI](../../images/add-license-ui.png)
+
+### Coder CLI
+
+First, ensure you have a license key
+([request a trial](https://coder.com/trial)) and the
+[Coder CLI](../../install/cli.md) installed.
+
+1. Save your license key to disk and make note of the path
+2. Open a terminal
+3. Ensure you are logged into your Coder deployment
+
+   `coder login <access url>`
+
+4. Run
+
+   `coder licenses add -f <path to your license key>`
+
+</div>
diff --git a/docs/admin/users/groups.md b/docs/admin/users/groups.md
@@ -0,0 +1,15 @@
+# Groups
+
+Groups can be used with [template RBAC](../templates/template-permissions.md) to
+give groups of users access to specific templates. They can be defined via the
+Coder web UI,
+[synced from your identity provider](./oidc-auth.md#group-sync-enterprise-premium)
+or
+[managed via Terraform](https://registry.terraform.io/providers/coder/coderd/latest/docs/resources/template).
+
+![Groups](../../images/groups.png)
+
+## Enabling this feature
+
+This feature is only available with a
+[Premium or Enterprise license](https://coder.com/pricing).
diff --git a/docs/admin/users/oidc-auth.md b/docs/admin/users/oidc-auth.md
@@ -151,7 +151,7 @@ CODER_TLS_CLIENT_CERT_FILE=/path/to/cert.pem
 CODER_TLS_CLIENT_KEY_FILE=/path/to/key.pem
 ```
 
-## Group Sync (enterprise)
+## Group Sync (enterprise) (premium)
 
 If your OpenID Connect provider supports group claims, you can configure Coder
 to synchronize groups in your auth provider to groups within Coder.
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -238,6 +238,11 @@
 							"path": "./admin/users/groups-roles.md",
 							"state": ["enterprise", "premium"]
 						},
+						{
+							"title": "Groups",
+							"path": "./admin/users/groups.md",
+							"state": ["enterprise", "premium"]
+						},
 						{
 							"title": "Organizations",
 							"path": "./admin/users/organizations.md",
@@ -532,6 +537,12 @@
 							"state": ["enterprise", "premium"]
 						}
 					]
+				},
+				{
+					"title": "Licensing",
+					"description": "Configure licensing for your deployment",
+					"path": "./admin/licensing/README.md",
+					"icon_path": "./images/icons/licensing.svg"
 				}
 			]
 		},

Original file line number	Diff line number	Diff line change
`@@ -238,6 +238,11 @@`
`238`	`238`	`"path": "./admin/users/groups-roles.md",`
`239`	`239`	`"state": ["enterprise", "premium"]`
`240`	`240`	`},`
	`241`	`+ {`
	`242`	`+ "title": "Groups",`
	`243`	`+ "path": "./admin/users/groups.md",`
	`244`	`+ "state": ["enterprise", "premium"]`
	`245`	`+ },`
`241`	`246`	`{`
`242`	`247`	`"title": "Organizations",`
`243`	`248`	`"path": "./admin/users/organizations.md",`
`@@ -532,6 +537,12 @@`
`532`	`537`	`"state": ["enterprise", "premium"]`
`533`	`538`	`}`
`534`	`539`	`]`
	`540`	`+ },`
	`541`	`+ {`
	`542`	`+ "title": "Licensing",`
	`543`	`+ "description": "Configure licensing for your deployment",`
	`544`	`+ "path": "./admin/licensing/README.md",`
	`545`	`+ "icon_path": "./images/icons/licensing.svg"`
`535`	`546`	`}`
`536`	`547`	`]`
`537`	`548`	`},`