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
Next Next commit
Expanded tutorial
I have read the CLA Document and I hereby sign the CLA
  • Loading branch information
marcpaq committed Aug 28, 2023
commit 50e904165a68d8a86ce3fbcc4c299be72fbd1b80
Binary file added docs/images/templates/create-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/templates/create-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/templates/new-workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/templates/use-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/templates/workspace-ready.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@
"icon_path": "./images/icons/picture.svg",
"children": [
{
"title": "Creating, editing, and updating templates",
"description": "Working with templates",
"title": "Working with templates",
"description": "Creating, editing, and updating templates",
"path": "./templates/creating.md"
},
{
Expand Down
61 changes: 39 additions & 22 deletions docs/templates/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,69 @@

A common way to create a template is to begin with a starter template
then modify it for your needs. Coder makes this easy with starter
templates for popular development targets, like Docker, Kubernetes,
templates for popular development targets like Docker, Kubernetes,
Azure, and so on. Once your template is up and running, you can edit
it in the Coder web page. Coder even handles versioning for you.

In this tutorial, you'll create your first template from the Docker
starter template. You'll need ssh access to a computer that has both
Docker and Coder installed on it.
starter template. You'll need a computer or cloud computing instance
with both Docker and Coder installed on it.

To create a template, you'll work with both the Coder web page and the
command line. You only need to do this once to create a template.
After that, you can edit your template from the Coder web page.

## Log in to Coder

In your web browser, go to your Coder instance to log in.

Also, in a terminal, ssh into the computer where Docker and Coder are
installed, then log into Coder.

```console
marc@example:~$ coder login https://example-access-url.coder.app
Open the following in your browser:

https://example-access-url.coder.app/cli-auth

> Paste your token here:
> Welcome to Coder, marc! You're authenticated.
marc@example:~$
```

## Choose a starter template

In the web browser, select **Templates** > **Starter Templates**.
### 1. Choose a starter template

Select **Templates** > **Starter Templates**.

![Starter Templates button](../images/templates/starter-templates.png)

In **Filter**, select **Docker** then select **Develop in Docker**.

![Choosing a starter template](../images/templates/develop-in-docker-template.png)

## Try out your new template
Select **Use template**.

![Using a starter template](../images/use-template.png)

### 2. Create your template

In **Create template**, fill in **Name** and **Display name**,then scroll down and select **Create template**.

![Creating a template](../images/create-template.png)

### 3. Create a workspace from your template

When the template is ready, select **Create Workspace**.

![Create workspace](../images/create-workspace.png)

In **New workspace**, fill in **Name** then scroll down to select **Create Workspace**.

![New workspace](../images/new-workspace.png)

Coder starts your new workspace from your template.

### 4. Use your workspace

After a few seconds, you can use your workspace. This starter template
lets you connect to your workspace via VS Code, coder-server, a
browser-based terminal, or SSH.

![Workspace is ready](../images/workspace-ready.png)


## Try out your new workspace



## Creating a template for Kubernetes

## Next steps

- [Anatomy of a template](./anatomy.md)
- [Setting up templates](./best-practices.md)