Skip to content

Commit bb4ecd7

Browse files
author
Katie Horne
authored
chore: update quickstart (docs) (coder#2381)
1 parent 0f44048 commit bb4ecd7

File tree

3 files changed

+29
-8
lines changed

3 files changed

+29
-8
lines changed

docs/images/code-server.png

169 KB
Loading

docs/install.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This article walks you through the various ways of installing and deploying Code
44

55
## install.sh
66

7-
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The install script
7+
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. The install script
88
attempts to use the system package manager detection-reference if possible.
99

1010
You can preview what occurs during the install process:
@@ -120,5 +120,10 @@ We publish self-contained .zip and .tar.gz archives in [GitHub releases](https:/
120120

121121
```bash
122122
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
123-
coder server
123+
coder server
124124
```
125+
126+
## Next steps
127+
128+
Once you've installed and started Coder, see the [quickstart](./quickstart.md)
129+
for instructions on creating your first template and workspace.

docs/quickstart.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Quickstart
22

3-
This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md).
3+
This guide will walk you through creating your first template and workspace.
4+
5+
## Prerequisites
6+
7+
Please [install Coder](./install.md) before proceeding with the steps outlined in this article.
48

59
## Creating your first template and workspace
610

@@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template:
1014
coder templates init
1115
```
1216

13-
Follow the CLI instructions to modify and create the template specific for your
14-
usage (e.g., a template to **Develop in Linux on Google Cloud**).
17+
Follow the CLI instructions to select an example that you can modify for your
18+
specific usage (e.g., a template to **Develop code-server in Docker**):
19+
20+
1. Navigate into your new templates folder and create your first template using
21+
the provided command (e.g., `cd ./docker-code-server && coder templates create`)
22+
23+
1. Answer the CLI prompts; when done, confirm that you want to create your template.
1524

1625
Create a workspace using your template:
1726

@@ -25,13 +34,20 @@ Connect to your workspace via SSH:
2534
coder ssh <workspaceName>
2635
```
2736

37+
You can also access your workspace using the **access URL** you provided when
38+
deploying Coder (if you're using a temporary deployment and you opted to use
39+
Coder's tunnel, use the access URL you were provided). Log in with the admin
40+
credentials provided to you by Coder.
41+
42+
![Coder Web UI with code-server](images/code-server.png)
43+
2844
## Modifying templates
2945

30-
If needed, you can edit the Terraform template using a sample template:
46+
You can edit the Terraform template as follows:
3147

3248
```sh
3349
coder templates init
34-
cd gcp-linux/
50+
cd gcp-linux # modify this line as needed to access the template
3551
vim main.tf
36-
coder templates update gcp-linux
52+
coder templates update gcp-linux # updates the template
3753
```

0 commit comments

Comments
 (0)