Skip to content

docs: improve workspaces and templates doc #9139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 42 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
224bf4c
Reorg, updated/new screenshots, consistent terminology
marcpaq Aug 16, 2023
d494d28
First pass
marcpaq Aug 17, 2023
eabd21f
Another pass
marcpaq Aug 17, 2023
a92693d
Added integration section
marcpaq Aug 21, 2023
46618e4
New outline for template pages, small updates
marcpaq Aug 22, 2023
85535d0
Revised outline for templates, added tutorial
marcpaq Aug 23, 2023
bbd4928
First pass at tutorial
marcpaq Aug 23, 2023
3cc2dbb
Some feedback from Ben.
marcpaq Aug 23, 2023
cb39a6d
Update docs/workspaces.md
marcpaq Aug 25, 2023
6706032
Update docs/workspaces.md
marcpaq Aug 25, 2023
4e4b9e5
Update docs/workspaces.md
marcpaq Aug 25, 2023
351c457
Fixed typos
marcpaq Aug 25, 2023
50e9041
Expanded tutorial
marcpaq Aug 28, 2023
ed27c28
New screenshots, improved tutorial, revised anatomy
marcpaq Sep 7, 2023
744bad0
Improved tutorial. Anatomy is now a guided tour.
marcpaq Sep 8, 2023
58d5c9e
First pass at guided tour
marcpaq Sep 8, 2023
bf5228c
Updated authentication info
marcpaq Sep 11, 2023
92eea5f
Reorganized the guided tour
marcpaq Sep 12, 2023
302f5dd
Edited more template pages
marcpaq Sep 13, 2023
c80c0e3
Update docs/templates/tour.md
marcpaq Sep 15, 2023
e308e5d
Update docs/templates/tour.md
marcpaq Sep 15, 2023
22570dd
Update docs/templates/tour.md
marcpaq Sep 15, 2023
cbeac94
Update docs/templates/tutorial.md
marcpaq Sep 15, 2023
b12c1d6
Update docs/templates/tour.md
marcpaq Sep 15, 2023
b4f33d5
Update docs/templates/tour.md
marcpaq Sep 15, 2023
ec1741e
Update docs/templates/tour.md
marcpaq Sep 15, 2023
223dc9a
Update docs/templates/tour.md
marcpaq Sep 15, 2023
cb266c6
Update docs/templates/tour.md
marcpaq Sep 15, 2023
b5c0371
Revised devcontainers and docker-in-workspaces
marcpaq Sep 15, 2023
9f16953
Edited and added screenshots
marcpaq Sep 18, 2023
6bda970
Prepared first draft, except docs/templates/open-in-coder.md
marcpaq Sep 19, 2023
c2d992b
Fix typo
marcpaq Oct 3, 2023
c9a6c3c
remove legacy parameters and migration guide
matifali Oct 9, 2023
3efae01
Use coder templates create
marcpaq Oct 11, 2023
267639c
Added screenshot for workspace template variables
marcpaq Oct 12, 2023
5c64352
Made it prettier
marcpaq Oct 12, 2023
dbfc80d
Fixed minor typos and markdown problems
marcpaq Oct 12, 2023
6506168
edits to repairing workspaces
bpmct Oct 15, 2023
588a08a
fix broken links in product
bpmct Oct 15, 2023
151687d
Added troubleshooting, minor corrections.
marcpaq Oct 16, 2023
456f5d5
fix terminal links
bpmct Oct 16, 2023
59528ff
fmt
matifali Oct 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fmt
  • Loading branch information
matifali committed Oct 16, 2023
commit 59528ff806f09213b1183dbf5900d1c8a9914f21
2 changes: 0 additions & 2 deletions docs/templates/open-in-coder.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,5 +104,3 @@ This can be used to pre-fill the git repo URL, disk size, image, etc.
```

![Pre-filled parameters](../images/templates/pre-filled-parameters.png)


1 change: 0 additions & 1 deletion docs/templates/resource-persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,3 @@ resource "docker_volume" "home_volume" {
}
}
```

5 changes: 1 addition & 4 deletions docs/templates/tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ we'll create.

![Template architecture](../images/templates/template-architecture.png)


## 1. Create template files

On your local computer, create a directory for your template and
Expand Down Expand Up @@ -83,7 +82,6 @@ image, which your template needs later:
- It installs the `sudo` and `curl` packages.
- It adds a `coder` user, including a home directory.


## 2. Set up template providers

Now you can edit the Terraform file, which provisions the workspace's resources.
Expand Down Expand Up @@ -412,11 +410,10 @@ The template-tour template has been created! Developers can provision a workspac
```

In your web browser, log in to your Coder dashboard, select
***Templates**. Your template is ready to use for new workspaces.
**\*Templates**. Your template is ready to use for new workspaces.

![Your new template, ready to use](../images/templates/template-tour.png)


## Next steps

- [Setting up templates](./best-practices.md)
Expand Down
5 changes: 2 additions & 3 deletions docs/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ Coder stores macOS and Linux logs at the following locations:

## Repairing workspaces

There are a couple of ways you can repair a workspace if its state
There are a couple of ways you can repair a workspace if its state
is out of sync with the template.

First, try re-entering parameters from a workspace.
First, try re-entering parameters from a workspace.

![Re-entering template variables](./images/template-variables.png)

Expand All @@ -154,4 +154,3 @@ coder state push <username>/<workspace name>

- Learn about how to personalize your workspace with [Dotfiles](./dotfiles.md)
- Learn about using [IDEs](./ides.md)

Binary file added filebrowser.db
Binary file not shown.
1 change: 1 addition & 0 deletions site/build/tsconfig.tsbuildinfo

Large diffs are not rendered by default.

16 changes: 12 additions & 4 deletions site/src/pages/TerminalPage/TerminalPageAlert.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ const mapAlertTypeToText: MapAlertTypeToComponent = {
The workspace{" "}
<Link
title="startup script has exited with an error"
href={docs("/templates/troubleshooting#startup-script-exited-with-an-error")}
href={docs(
"/templates/troubleshooting#startup-script-exited-with-an-error",
)}
target="_blank"
rel="noreferrer"
>
Expand All @@ -40,7 +42,9 @@ const mapAlertTypeToText: MapAlertTypeToComponent = {
because{" "}
<Link
title="your workspace may be incomplete."
href={docs("/templates/troubleshooting#your-workspace-may-be-incomplete")}
href={docs(
"/templates/troubleshooting#your-workspace-may-be-incomplete",
)}
target="_blank"
rel="noreferrer"
>
Expand All @@ -57,7 +61,9 @@ const mapAlertTypeToText: MapAlertTypeToComponent = {
but{" "}
<Link
title="your workspace may be incomplete."
href={docs("/templates/troubleshooting#your-workspace-may-be-incomplete")}
href={docs(
"/templates/troubleshooting#your-workspace-may-be-incomplete",
)}
target="_blank"
rel="noreferrer"
>
Expand All @@ -75,7 +81,9 @@ const mapAlertTypeToText: MapAlertTypeToComponent = {
this{" "}
<Link
title="session was started before the startup script finished"
href={docs("/templates/troubleshooting#your-workspace-may-be-incomplete")}
href={docs(
"/templates/troubleshooting#your-workspace-may-be-incomplete",
)}
target="_blank"
rel="noreferrer"
>
Expand Down