Skip to content

Commit b5b28c1

Browse files
committed
simplify wording
1 parent e87fb94 commit b5b28c1

File tree

4 files changed

+8
-30
lines changed

4 files changed

+8
-30
lines changed
Loading
-167 KB
Loading

docs/templates/index.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -69,38 +69,18 @@ coder templates create <template-name>
6969
> [examples/](https://github.com/coder/coder/tree/main/examples/templates)
7070
> directory in the repo.
7171
72-
## Template policies (enterprise)
72+
## Schedule settings (enterprise)
7373

74-
By default, developers have unlimited workspace usage and can use any template version. Template policies allows you to:
74+
While workspaces can auto-stop based on activity, users set this value per-workspace it can be continuously bumped to prevent a workspace from stopping. For large enterprises, this can drive up cloud cost and introduce security concerns, as workspaces are not kept up to date.
7575

76-
- Auto-stop workspaces after 3 hours of inactivity.
77-
- Require workspaces to be restarted frequently to ensure they use the most recent template version.
78-
- Disable workspace auto-start.
76+
To enforce auto-stopping, you can enforce a timeout for all workspaces, as well as a max session duration.
7977

80-
### Stop policy
81-
82-
Stop policies require workspaces be stopped (or restarted), regardless of activity:
83-
84-
- Daily (Restart on next quiet hours)
85-
- Weekly (Restart on weekends)
86-
- Custom (Every 2 weeks)
87-
88-
```text
89-
Every [2] [Weeks] on [Friday]
90-
or
91-
Every [2] [Days]
92-
or
93-
Every [4] [Weeks] on [Saturday]
94-
```
95-
96-
- Never
78+
![Workspace auto-stop settings](../images/templates/pre-filled-parameters.png)
9779

9880
Stops occur during a user's [quiet hours](../workspaces.md#quiet-hours), which prevent interruptions. If a user is still using their workspace, they can postpone a restart up to 3 hours.
9981

10082
Learn more about [workspace auto-stop](../workspaces.md#workspace-auto-stop)
10183

102-
<!-- TODO: Add the dashboard screenshots. We can remove the "most recent version" bullet point once we finish template version policies -->
103-
10484
## Customize templates
10585

10686
Example templates are not designed to support every use (e.g

docs/workspaces.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ information, see [Resource Persistence](./templates/resource-persistence.md).
3737
3838
When a workspace is deleted, all of the workspace's resources are deleted.
3939

40-
## Workspace auto-stop
40+
## Inactivity timeout
4141

4242
In Coder, workspaces can auto-stop when the user is not actively using the workspace. By default, Coder recognizes the following actions as activity and will keep the workspace online:
4343

@@ -47,15 +47,13 @@ In Coder, workspaces can auto-stop when the user is not actively using the works
4747

4848
> [Custom activity](#TODO) can be registered via Coder's REST API, such as an ongoing data science pipeline.
4949
50-
<!-- TODO. Document this. We may want to move to a custom activity section. See coder/coder[#8064](https://github.com/coder/coder/issues/8064) and coder/coder#5629 -->
51-
52-
Your workspace's auto-stop behavior can be seen in the dashboard. Template settings in Coder determine if users can alter their workspace schedules.
50+
Your workspace's auto-stop behavior can be seen in the dashboard. Template settings in Coder determine if users can alter their workspace schedules.
5351

5452
![TODO: use real screenshot](./images/workspaces/stops-after-3-hours.png)
5553

56-
### Max workspace lifetime (enterprise)
54+
### Max session length (enterpise)
5755

58-
Workspaces may also have a max lifetime, which enforces a stop or restart even if you are actively using your workspace.
56+
Workspaces may also have a max session length, which enforces a stop or restart even if you are actively using your workspace.
5957

6058
![TODO: use real screenshot](./images/workspaces/approaching-stop.png)
6159

0 commit comments

Comments
 (0)