Skip to content

Commit b6899e2

Browse files
jsjoeiojsjoeio
authored
docs: slim down readme (#2140)
* docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
1 parent 8cfe223 commit b6899e2

File tree

4 files changed

+101
-95
lines changed

4 files changed

+101
-95
lines changed

‎README.md

+18-95
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,30 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
88
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
99
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
1010

11-
## Run Coder *now*
12-
13-
```curl -L https://coder.com/install.sh | sh```
14-
15-
## What Coder does
16-
Coder creates remote development machines so you can develop your code from anywhere. #coder
17-
18-
> **Note**:
19-
> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose).
11+
Coder creates remote development machines so your team can develop from anywhere.
2012

2113
<p align="center">
2214
<img src="./docs/images/hero-image.png">
2315
</p>
2416

25-
**Code more**
26-
27-
- Build and test faster
28-
- Leveraging cloud CPUs, RAM, network speeds, etc.
29-
- Access your environment from any place on any client (even an iPad)
30-
- Onboard instantly then stay up to date continuously
31-
3217
**Manage less**
3318

3419
- Ensure your entire team is using the same tools and resources
3520
- Rollout critical updates to your developers with one command
3621
- Automatically shut down expensive cloud resources
3722
- Keep your source code and data behind your firewall
3823

39-
## How it works
40-
41-
Coder workspaces are represented with Terraform. But, no Terraform knowledge is
42-
required to get started. We have a database of pre-made templates built into the
43-
product.
44-
45-
<p align="center">
46-
<img src="./docs/images/providers-compute.png">
47-
</p>
48-
49-
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
50-
and whatever else Terraform lets you dream up.
51-
52-
[Learn more about managing infrastructure.](./docs/templates.md)
53-
54-
## IDE Support
24+
**Code more**
5525

56-
You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
26+
- Build and test faster
27+
- Leveraging cloud CPUs, RAM, network speeds, etc.
28+
- Access your environment from any place on any client (even an iPad)
29+
- Onboard instantly then stay up to date continuously
5730

58-
<p align="center">
59-
<img src="./docs/images/ide-icons.svg" height=72>
60-
</p>
31+
## Getting Started
6132

62-
## Installing Coder
33+
> **Note**:
34+
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).
6335
6436
There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux).
6537

@@ -81,66 +53,11 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m
8153
coder server --dev
8254
```
8355

84-
Use `coder --help` to get a complete list of flags and environment variables.
85-
86-
## Creating your first template and workspace
87-
88-
In a new terminal window, run the following to copy a sample template:
89-
90-
```bash
91-
coder templates init
92-
```
93-
94-
Follow the CLI instructions to modify and create the template specific for your
95-
usage (e.g., a template to **Develop in Linux on Google Cloud**).
96-
97-
Create a workspace using your template:
98-
99-
```bash
100-
coder create --template="yourTemplate" <workspaceName>
101-
```
102-
103-
Connect to your workspace via SSH:
104-
105-
```bash
106-
coder ssh <workspaceName>
107-
```
108-
109-
## Modifying templates
110-
111-
You can edit the Terraform template using a sample template:
112-
113-
```sh
114-
coder templates init
115-
cd gcp-linux/
116-
vim main.tf
117-
coder templates update gcp-linux
118-
```
56+
Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough.
11957

12058
## Documentation
12159

122-
- [About Coder](./docs/about.md#about-coder)
123-
- [Why remote development](./docs/about.md#why-remote-development)
124-
- [Why Coder](./docs/about.md#why-coder)
125-
- [What Coder is not](./docs/about.md#what-coder-is-not)
126-
- [Comparison: Coder vs. [product]](./docs/about.md#comparison)
127-
- [Templates](./docs/templates.md)
128-
- [Manage templates](./docs/templates.md#manage-templates)
129-
- [Persistent and ephemeral
130-
resources](./docs/templates.md#persistent-and-ephemeral-resources)
131-
- [Parameters](./docs/templates.md#parameters)
132-
- [Workspaces](./docs/workspaces.md)
133-
- [Create workspaces](./docs/workspaces.md#create-workspaces)
134-
- [Connect with SSH](./docs/workspaces.md#connect-with-ssh)
135-
- [Editors and IDEs](./docs/workspaces.md#editors-and-ides)
136-
- [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle)
137-
- [Updating workspaces](./docs/workspaces.md#updating-workspaces)
138-
139-
## Community
140-
141-
Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder!
142-
143-
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
60+
Visit our docs [here](./docs/index.md).
14461

14562
## Comparison
14663

@@ -155,7 +72,13 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa
15572

15673
---
15774

158-
_As of 5/27/22_
75+
_Last updated: 5/27/22_
76+
77+
## Community and Support
78+
79+
Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!
80+
81+
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
15982

16083
## Contributing
16184

‎docs/about.md

+23
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ By building on top of common development interfaces (SSH) and infrastructure too
99
> production environments, please consider [Coder v1](https://coder.com/docs) or
1010
> [code-server](https://github.com/cdr/code-server).
1111
12+
## How it works
13+
14+
Coder workspaces are represented with Terraform. But, no Terraform knowledge is
15+
required to get started. We have a database of pre-made templates built into the
16+
product.
17+
18+
<p align="center">
19+
<img src="./images/providers-compute.png">
20+
</p>
21+
22+
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
23+
and whatever else Terraform lets you dream up.
24+
25+
[Learn more about managing infrastructure.](./templates.md)
26+
27+
## IDE Support
28+
29+
You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
30+
31+
<p align="center">
32+
<img src="./images/ide-icons.svg" height=72>
33+
</p>
34+
1235
## Why remote development
1336

1437
Migrating from local developer machines to workspaces hosted by cloud services

‎docs/index.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Coder Documentation
2+
3+
## Table of Contents
4+
5+
- [About Coder](./about.md#about-coder)
6+
- [Why remote development](./about.md#why-remote-development)
7+
- [Why Coder](./about.md#why-coder)
8+
- [What Coder is not](./about.md#what-coder-is-not)
9+
- [Comparison: Coder vs. [product]](./about.md#comparison)
10+
- [Quickstart](./quickstart.md)
11+
- [Creating your first template and workspace](./quickstart.md#creating-your-first-template-and-workspace)
12+
- [Modifying templates](./quickstart.md#modifying-templates)
13+
- [Templates](./templates.md)
14+
- [Manage templates](./templates.md#manage-templates)
15+
- [Persistent and ephemeral
16+
resources](./templates.md#persistent-and-ephemeral-resources)
17+
- [Parameters](./templates.md#parameters)
18+
- [Workspaces](./workspaces.md)
19+
- [Create workspaces](./workspaces.md#create-workspaces)
20+
- [Connect with SSH](./workspaces.md#connect-with-ssh)
21+
- [Editors and IDEs](./workspaces.md#editors-and-ides)
22+
- [Workspace lifecycle](./workspaces.md#workspace-lifecycle)
23+
- [Updating workspaces](./workspaces.md#updating-workspaces)

‎docs/quickstart.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Quickstart
2+
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).
4+
5+
## Creating your first template and workspace
6+
7+
In a new terminal window, run the following to copy a sample template:
8+
9+
```bash
10+
coder templates init
11+
```
12+
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**).
15+
16+
Create a workspace using your template:
17+
18+
```bash
19+
coder create --template="yourTemplate" <workspaceName>
20+
```
21+
22+
Connect to your workspace via SSH:
23+
24+
```bash
25+
coder ssh <workspaceName>
26+
```
27+
28+
## Modifying templates
29+
30+
If needed, you can edit the Terraform template using a sample template:
31+
32+
```sh
33+
coder templates init
34+
cd gcp-linux/
35+
vim main.tf
36+
coder templates update gcp-linux
37+
```

0 commit comments

Comments
 (0)