Skip to content

Commit 468ffd9

Browse files
authored
docs: copy edit the organizations doc and add link to best practices (#15888)
[preview](https://coder.com/docs/@orgs-edit-202412/admin/users/organizations) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent e191d96 commit 468ffd9

File tree

2 files changed

+37
-167
lines changed

2 files changed

+37
-167
lines changed

docs/admin/users/organizations.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,14 @@ with multiple platform teams, all with unique resources:
1414

1515
![Organizations Example](../../images/admin/users/organizations/diagram.png)
1616

17+
For more information about how to use organizations, visit the
18+
[organizations best practices](../../tutorials/best-practices/organizations.md)
19+
guide.
20+
1721
## The default organization
1822

19-
All Coder deployments start with one organization called `Coder`.
23+
All Coder deployments start with one organization called `Coder`. All new users
24+
are added to this organization by default.
2025

2126
To edit the organization details, navigate to `Deployment -> Organizations` in
2227
the top bar:
@@ -30,29 +35,29 @@ From there, you can manage the name, icon, description, users, and groups:
3035
## Additional organizations
3136

3237
Any additional organizations have unique admins, users, templates, provisioners,
33-
groups, and workspaces. Each organization must have at least one
34-
[provisioner](../provisioners.md) as the built-in provisioner only applies to
38+
groups, and workspaces. Each organization must have at least one dedicated
39+
[provisioner](../provisioners.md) since the built-in provisioner only applies to
3540
the default organization.
3641

3742
You can configure [organization/role/group sync](./idp-sync.md) from your
3843
identity provider to avoid manually assigning users to organizations.
3944

40-
## Creating an organization
45+
## How to create an organization
4146

4247
### Prerequisites
4348

44-
- Coder v2.16+ deployment with Premium license with Organizations enabled
49+
- Coder v2.16+ deployment with Premium license and Organizations enabled
4550
([contact your account team](https://coder.com/contact)) for more details.
4651
- User with `Owner` role
4752

4853
### 1. Create the organization
4954

50-
Within the sidebar, click `New organization` to create an organization. In this
55+
In the sidebar, select **New organization** to create an organization. In this
5156
example, we'll create the `data-platform` org.
5257

5358
![New Organization](../../images/admin/users/organizations/new-organization.png)
5459

55-
From there, let's deploy a provisioner and template for this organization.
60+
Next deploy a provisioner and template for this organization.
5661

5762
### 2. Deploy a provisioner
5863

@@ -61,50 +66,50 @@ for executing Terraform/OpenTofu to provision the infrastructure for workspaces
6166
and testing templates. Before creating templates, we must deploy at least one
6267
provisioner as the built-in provisioners are scoped to the default organization.
6368

64-
Using Coder CLI, run the following command to create a key that will be used to
65-
authenticate the provisioner:
69+
1. Using Coder CLI, run the following command to create a key that will be used
70+
to authenticate the provisioner:
71+
72+
```shell
73+
coder provisioner keys create data-cluster-key --org data-platform
74+
Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again.
6675

67-
```sh
68-
coder provisioner keys create data-cluster-key --org data-platform
69-
Successfully created provisioner key data-cluster! Save this authentication token, it will not be shown again.
76+
< key omitted >
77+
```
7078

71-
< key omitted >
72-
```
79+
1. Start the provisioner with the key on your desired platform.
7380

74-
Next, start the provisioner with the key on your desired platform. In this
75-
example, we'll start it using the Coder CLI on a host with Docker. For
76-
instructions on using other platforms like Kubernetes, see our
77-
[provisioner documentation](../provisioners.md).
81+
In this example, start the provisioner using the Coder CLI on a host with
82+
Docker. For instructions on using other platforms like Kubernetes, see our
83+
[provisioner documentation](../provisioners.md).
7884

79-
```sh
80-
export CODER_URL=https://<your-coder-url>
81-
export CODER_PROVISIONER_DAEMON_KEY=<key>
82-
coder provisionerd start --org <org-name>
83-
```
85+
```sh
86+
export CODER_URL=https://<your-coder-url>
87+
export CODER_PROVISIONER_DAEMON_KEY=<key>
88+
coder provisionerd start --org <org-name>
89+
```
8490

8591
### 3. Create a template
8692

8793
Once you've started a provisioner, you can create a template. You'll notice the
88-
"Create Template" screen now has an organization dropdown:
94+
**Create Template** screen now has an organization dropdown:
8995

9096
![Template Org Picker](../../images/admin/users/organizations/template-org-picker.png)
9197

92-
### 5. Add members
98+
### 4. Add members
9399

94-
Navigate to `Deployment->Organizations` to add members to your organization.
95-
Once added, they will be able to see the organization-specific templates.
100+
From **Administration > Settings**, select **Organizations** to add members to
101+
your organization. Once added, they will be able to see the
102+
organization-specific templates.
96103

97104
![Add members](../../images/admin/users/organizations/organization-members.png)
98105

99-
### 6. Create a workspace
106+
### 5. Create a workspace
100107

101108
Now, users in the data platform organization will see the templates related to
102109
their organization. Users can be in multiple organizations.
103110

104111
![Workspace List](../../images/admin/users/organizations/workspace-list.png)
105112

106-
## Beta
113+
## Next steps
107114

108-
As of v2.16.0, Organizations is in beta. If you encounter any issues, please
109-
[file an issue](https://github.com/coder/coder/issues/new) or contact your
110-
account team.
115+
- [Organizations - best practices](../../tutorials/best-practices/organizations.md)

docs/tutorials/using-organizations.md

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy