Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit b27b43c

Browse files
author
Katie Horne
committed
chore: apply changes from review
1 parent 932b3ef commit b27b43c

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

guides/workspaces.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Workspace organization"
33
description: Learn how to organize your Coder workspaces.
44
---
55

6-
This article walks you through considerations you should take when deciding how
7-
to set up your Coder workspaces.
6+
This article describes considerations for deciding how to set up your Coder
7+
workspaces.
88

99
In general, the fewer workspaces per developer, the easier it is for the
1010
individual developer to manage. However, the complexity of the underlying images
@@ -18,12 +18,12 @@ you would a laptop: the workspace is where you have all of your languages,
1818
dependencies, and tooling installed, and it is the one place you'd go to work on
1919
your projects.
2020

21-
Upsides:
21+
Benefits:
2222

23-
- Ease of management due to the smaller number of workspaces
23+
- Fewer workspaces to manage
2424
- No need to switch between workspaces for different projects
2525

26-
Downsides:
26+
Limitations:
2727

2828
- The size of the workspace can grow quite large
2929
- The image supporting such a workspace can become complex
@@ -33,28 +33,26 @@ Downsides:
3333
In this situation, you would create one workspace for your JavaScript projects,
3434
one workspace for your Python projects, and so on.
3535

36-
Upsides:
36+
Benefits:
3737

38-
- Streamlined images due to them only containing only one language and its
39-
accompanying dependencies
38+
- Smaller images, since they only contain one language and its dependencies
4039

41-
Downsides:
40+
Limitations:
4241

43-
- Developers potentially have multiple workspaces, each of which are are the
44-
larger side.
42+
- Developers may have multiple workspaces, consuming more storage space overall
4543

4644
## One workspace per project per developer
4745

4846
Each developer has multiple workspaces, with each workspace devoted to one
4947
project. If a developer is currently working on three projects, they'd have
5048
three workspaces.
5149

52-
Upsides:
50+
Benefits:
5351

5452
- Streamlined images with only the languages and dependencies included
5553
- Smaller, lighter workspaces
5654

57-
Downsides:
55+
Limitations:
5856

5957
- As the number of workspaces per developer grows, the importance of
6058
well-defined dotfiles grow to ensure that developers do not spend too much
@@ -67,7 +65,7 @@ A subset of this category is one workspace per **major** version of a project
6765
you to change the underlying image, so you can update the image (changing out
6866
the language and any dependencies) if needed.
6967

70-
The upsides and downsides of this option are similar to those involved with
68+
The benefits and limitations of this option are similar to those involved with
7169
setting up one workspace per project per developer.
7270

7371
## One workspace per feature/branch

manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,9 @@
528528
"path": "./guides/troubleshooting/vite-hmr.md"
529529
}
530530
]
531+
},
532+
{
533+
"path": "./guides/workspaces.md"
531534
}
532535
]
533536
},

0 commit comments

Comments
 (0)