Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6f96921

Browse files
author
Katie Horne
authored
chore: validate docs (#1485)
1 parent cabc164 commit 6f96921

File tree

3 files changed

+47
-31
lines changed

3 files changed

+47
-31
lines changed

docs/README.md

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,52 +20,69 @@ Provision remote development environments with Terraform.
2020

2121
## Installing Coder
2222

23-
Install [the latest release](https://github.com/coder/coder/releases) on a system with
24-
at least 1 CPU core and 2 GB RAM.
23+
We recommend installing [the latest
24+
release](https://github.com/coder/coder/releases) on a system with at least 1
25+
CPU core and 2 GB RAM:
2526

26-
To test, start with dev mode (all data is in-memory and is destroyed on exit):
27+
1. Download the release appropriate for your operating system
28+
1. Unzip the folder you just downloaded, and move the `coder` executable to a
29+
location that's on your `PATH`
2730

28-
```bash
29-
coder server --dev
30-
```
31+
> Make sure you have the appropriate credentials for your cloud provider (e.g.,
32+
> access key ID and secret access key for AWS).
3133
32-
To run a production deployment with PostgreSQL:
34+
You can set up a temporary deployment, a production deployment, or a system service:
3335

34-
```bash
35-
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
36-
coder server
37-
```
36+
- To set up a **temporary deployment**, start with dev mode (all data is in-memory and is
37+
destroyed on exit):
38+
39+
```bash
40+
coder server --dev
41+
```
42+
43+
- To run a **production deployment** with PostgreSQL:
44+
45+
```bash
46+
CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
47+
coder server
48+
```
3849

39-
To run as a system service, install with `.deb` (Debian, Ubuntu) or `.rpm`
50+
- To run as a **system service**, install with `.deb` (Debian, Ubuntu) or `.rpm`
4051
(Fedora, CentOS, RHEL, SUSE):
4152

42-
```bash
43-
# Edit the configuration!
44-
sudo vim /etc/coder.d/coder.env
45-
sudo service coder restart
46-
```
53+
```bash
54+
# Edit the configuration!
55+
sudo vim /etc/coder.d/coder.env
56+
sudo service coder restart
57+
```
4758

48-
Use `coder start --help` to get a complete list of flags and environment
59+
> Use `coder --help` to get a complete list of flags and environment
4960
variables.
5061

51-
### Your first workspace
62+
## Creating your first template and workspace
5263

53-
In a new terminal, create a template (e.g., a template to **Develop in Linux on
54-
Google Cloud**):
64+
In a new terminal window, run the following to copy a sample template:
5565

5666
```bash
5767
coder templates init
58-
coder templates create
5968
```
6069

61-
Create a workspace and connect to it via SSH:
70+
Follow the CLI instructions to modify and create the template specific for your
71+
usage (e.g., a template to **Develop in Linux on Google Cloud**).
72+
73+
Create a workspace using your template:
74+
75+
```bash
76+
coder create --template="yourTemplate" <workspaceName>
77+
```
78+
79+
Connect to your workspace via SSH:
6280

6381
```bash
64-
coder create my-first-workspace
65-
coder ssh my-first-workspace
82+
coder ssh <workspaceName>
6683
```
6784

68-
### Modifying templates
85+
## Modifying templates
6986

7087
You can edit the Terraform template using a sample template:
7188

docs/templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to everybody. Users can also manually update their workspaces.
99

1010
## Manage templates
1111

12-
Coder provides production-ready [sample template](../examples/), but you can
12+
Coder provides production-ready [sample templates](../examples/), but you can
1313
modify the templates with Terraform.
1414

1515
```sh

docs/workspaces.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ templates](./templates.md):
1212
# create a workspace from the template; specify any variables
1313
coder create <workspace-name>
1414

15-
# show the resources behind the workspace, and how to connect
15+
# show the resources behind the workspace and how to connect
1616
coder show <workspace-name>
1717
```
1818

@@ -23,8 +23,7 @@ IDE with remote development support:
2323

2424
```sh
2525
coder config-ssh
26-
27-
ssh coder.<workspace-name>
26+
coder ssh <workspaceName>
2827
```
2928

3029
## Editors and IDEs
@@ -61,7 +60,7 @@ resources](./templates.md#persistent-and-ephemeral-resources).
6160
> where to store files, install software, etc., so that they persist. Default
6261
> templates are documented in [../examples](../examples/).
6362
>
64-
> You can use `coder workspace show <workspace-name>` to see which resources are
63+
> You can use `coder show <workspace-name>` to see which resources are
6564
> persistent and which are ephemeral.
6665
6766
When a workspace is deleted, all of the workspace's resources are deleted.

0 commit comments

Comments
 (0)