Skip to content

Commit 0763b35

Browse files
matifalimatifali
committed
rebase on main 
1 parent 0d20438 commit 0763b35

File tree

14 files changed

+367
-67
lines changed

14 files changed

+367
-67
lines changed

‎docs/install/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Installing Coder
22

3-
There are several ways to install Coder. If you're trying Coder for the first time, our [install script](./cli.md) is the most straightforward. For production installs, we recommend using [Kubernetes](./kubernetes.md).
3+
TODO: Make this look great
44

55
<children></children>

‎docs/manifest.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2-
"versions": ["main"],
2+
"versions": [
3+
"main"
4+
],
35
"routes": [
46
{
57
"title": "About",

‎docs/manifest.old.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@
519519
]
520520
},
521521
{
522-
"title": "REST API",
522+
"title": "API",
523523
"description": "Learn how to use Coderd API",
524524
"path": "./api/index.md",
525525
"icon_path": "./images/icons/api.svg",

‎docs/start/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Coder is an open-source platform for creating and managing developer workspaces
44
on your preferred clouds and servers.
55

66
<p align="center">
7-
<img src="../images/hero-image.png">
7+
<img src="./images/hero-image.png">
88
</p>
99

1010
By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
@@ -22,7 +22,7 @@ required to get started. We have a database of pre-made templates built into the
2222
product.
2323

2424
<p align="center">
25-
<img src="../images/providers-compute.png">
25+
<img src="./images/providers-compute.png">
2626
</p>
2727

2828
Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
@@ -32,7 +32,7 @@ and whatever else Terraform lets you dream up.
3232

3333
## IDE Support
3434

35-
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/).
35+
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/).
3636

3737
<p align="center">
3838
<img src="./images/ide-icons.svg" height=72>

‎docs/start/coder-tour.md

Lines changed: 41 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
# Tour Coder and with your first deployment
1+
## Tour Coder and Set up your first deployment.
22

3-
This guide walks through the core product concepts by setting up a Coder
4-
deployment, creating your first template, and connecting to a workspace. This is
5-
made readily available by leveraging our
3+
For day-zero Coder users, we recommend following this guide to set up a local
4+
Coder deployment, create your first template, and connect to a workspace. This
5+
is completely free and leverages our
66
[open source repository](https://github.com/coder/coder).
77

88
We'll use [Docker](https://docs.docker.com/engine) to manage the compute for a
9-
slim deployment.
9+
slim deployment to experiment with
10+
[workpsaces](../tutorials/workspaces/README.md) and
11+
[templates](../tutorials/templates/README.md).
12+
13+
Docker is not necessary for every Coder deployment and is only used here for
14+
simplicity.
1015

1116
# Set up your Coder Deployment
1217

13-
### 1. Install Docker
18+
## 1. Install Docker
1419

15-
First, install [Docker](https://docs.docker.com/engine/install) locally.
20+
First, install [Docker](https://docs.docker.com/engine/install/) locally.
1621

1722
> If you already have the Coder binary installed, restart it after installing
1823
> Docker.
1924
20-
### 2. Install Coder daemon
21-
22-
A single binary contains the CLI (`coder`) and is used for both the Coder server
23-
and the client.
25+
## 2. Install Coder daemon
2426

2527
<div class="tabs">
2628

@@ -34,6 +36,11 @@ curl -L https://coder.com/install.sh | sh
3436

3537
## Windows
3638

39+
> **Important:** If you plan to use the built-in PostgreSQL database, you will
40+
> need to ensure that the
41+
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
42+
> is installed.
43+
3744
You can use the
3845
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
3946
package manager to install Coder:
@@ -42,17 +49,9 @@ package manager to install Coder:
4249
winget install Coder.Coder
4350
```
4451

45-
> **Important:** If you plan to use the built-in PostgreSQL database, you will
46-
> need to ensure that the
47-
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
48-
> is installed.
49-
5052
</div>
5153

52-
> See our [install docs](../install/README.md) for other methods of installing
53-
> and deploying Coder.
54-
55-
### 3. Start the server
54+
## 3. Start the server
5655

5756
To start or restart the Coder deployment, use the following command:
5857

@@ -68,10 +67,9 @@ create your first administrator account.
6867
Once you've signed in, you'll be brought to an empty workspaces page, which
6968
we'll soon populate with your first development environments.
7069

71-
> To learn more about interacting with the control plane through the terminal,
72-
> see our `coder server` [CLI docs](../reference/cli/server.md).
70+
### More information on the Coder Server
7371

74-
## Create your first template
72+
# Create your first template
7573

7674
A common way to create a template is to begin with a starter template then
7775
modify it for your needs. Coder makes this easy with starter templates for
@@ -80,13 +78,10 @@ template is up and running, you can edit it in the Coder dashboard. Coder even
8078
handles versioning for you so you can publish official updates or revert to
8179
previous versions.
8280

83-
> Read more about templates in our
84-
> [tutorials section](../admin/templates/README.md).
85-
8681
In this tutorial, you'll create your first template from the Docker starter
8782
template.
8883

89-
### 1. Choose a starter template
84+
## 1. Choose a starter template
9085

9186
Select **Templates** to see the **Starter Templates**. Use the **Docker
9287
Containers** template by pressing **Use Template**.
@@ -96,34 +91,23 @@ Containers** template by pressing **Use Template**.
9691
> You can also a find a comprehensive list of starter templates in **Templates**
9792
> -> **Create Template** -> **Starter Templates**.
9893
99-
### 2. Create your template
94+
## 2. Create your template
10095

10196
In **Create template**, fill in **Name** and **Display name**, then select
10297
**Create template**.
10398

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

106-
### Other template resources
101+
TODO:
107102

108-
- [Templates overview](../admin/templates/README.md)
109-
- [Create templates through the CLI](../cli/templates_create.md)
110-
- See our
111-
[Community Templates](https://github.com/coder/coder/blob/main/examples/templates/community-templates.md)
112-
in Github
113-
- Create a template from a [Dev Container](../templates/dev-containers.md)
103+
- add CLI guide for making a new template
104+
- refactor text below to be more beginner-friendly
114105

115106
# Create a workspace
116107

117-
Coder workspaces are the primary interface for end-users. Each workspace is
118-
defined by a template, but can be modified with parameters and settings. The
119-
easiest way to create a workspace is through the template GUI.
120-
121-
> Read more about templates in our
122-
> [administration docs](../admin/templates/README.md).
108+
## 1. Create a workspace from your template
123109

124-
### 1. Create a workspace from your template
125-
126-
From the template page, select **Create Workspace**.
110+
When the template is ready, select **Create Workspace**.
127111

128112
![Template Preview](../images/start/template-preview.png)
129113

@@ -138,7 +122,7 @@ After a few seconds, your workspace is ready to use.
138122

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

141-
### 2. Try out your new workspace
125+
## 4. Try out your new workspace
142126

143127
This starter template lets you connect to your workspace in a few ways:
144128

@@ -158,7 +142,7 @@ This starter template lets you connect to your workspace in a few ways:
158142
159143
When you're done, you can stop the workspace.
160144

161-
### Modify your template
145+
## 6. Modify your template
162146

163147
Now you can modify your template to suit your team's needs.
164148

@@ -168,26 +152,29 @@ web browser.
168152

169153
In the Coder dashboard, select **Templates** then your first template.
170154

171-
![Selecting the first template](../images/start/first-template.png)
155+
![Selecting the first template](../images/templates/select-template.png)
156+
157+
In the drop-down menu, select **Edit files**.
158+
159+
![Edit template files](../images/templates/edit-files.png)
172160

173-
In the this view, select **Source Code** to view and edit the template files.
161+
Expand the **build** directory and select **Dockerfile**.
174162

175-
![Edit template files](../images/start/template-source-code.png)
163+
![Selecting source code](../images/templates/source-code.png)
176164

177-
Click the **Edit** button at the top-right of the `build/Dockerfile` to open the
178-
in-browser editor then replace `golang` with `python3`.
165+
Edit `build/Dockerfile` to replace `golang` with `python3`.
179166

180-
![Editing source code](../images/start/template-edit-source-code.png)
167+
![Editing source code](../images/templates/edit-source-code.png)
181168

182169
Select **Build template** and wait for Coder to prepare the template for
183170
workspaces.
184171

185-
![Building a template](../images/start/build-template.png)
172+
![Building a template](../images/templates/build-template.png)
186173

187174
Select **Publish version**. In the **Publish new version** dialog, make sure
188175
**Promote to default version** is checked then select **Publish**.
189176

190-
![Publish a template](../images/start/template-publish.png)
177+
![Publish a template](../images/templates/publish.png)
191178

192179
Now when developers create a new workspace from this template, they can use
193180
Python 3 instead of Go.
@@ -197,7 +184,3 @@ template, Coder will notify them that there's a new version of the template.
197184

198185
You can also handle [change management](./change-management.md) through your own
199186
repo and continuous integration.
200-
201-
### Next Steps
202-
203-
- TODO

‎docs/start/first-template.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Your first template
2+
3+
A common way to create a template is to begin with a starter template then
4+
modify it for your needs. Coder makes this easy with starter templates for
5+
popular development targets like Docker, Kubernetes, Azure, and so on. Once your
6+
template is up and running, you can edit it in the Coder dashboard. Coder even
7+
handles versioning for you so you can publish official updates or revert to
8+
previous versions.
9+
10+
In this tutorial, you'll create your first template from the Docker starter
11+
template.
12+
13+
## Before you start
14+
15+
Use the [previous section](./local-deploy.md) of this guide to set up
16+
[Docker](https://docs.docker.com/get-docker/) and [Coder](../install/index.md)
17+
on your local machine to continue.
18+
19+
## 1. Log in to Coder
20+
21+
In your web browser, go to your Coder dashboard using the URL provided during
22+
setup to log in.
23+
24+
## 2. Choose a starter template
25+
26+
Select **Templates** to see the **Starter Templates**. Use the **Docker
27+
Containers** template by pressing **Use Template**.
28+
29+
![Starter Templates UI](../images/start/starter-templates.png)
30+
31+
> You can also a find a comprehensive list of starter templates in **Templates**
32+
> -> **Create Template** -> **Starter Templates**. s
33+
34+
## 3. Create your template
35+
36+
In **Create template**, fill in **Name** and **Display name**, then select
37+
**Create template**.
38+
39+
![Creating a template](../images/start/create-template.png)
40+
41+
TODO:
42+
43+
- add CLI guide for making a new template
44+
- refactor text below to be more beginner-friendly
45+
46+
<!-- ## 4. Create a workspace from your template
47+
48+
When the template is ready, select **Create Workspace**.
49+
50+
![Template Preview](../images/start/template-preview.png)
51+
52+
In **New workspace**, fill in **Name** then scroll down to select **Create
53+
Workspace**.
54+
55+
![Create Workspace](../images/start/create-workspace.png)
56+
57+
Coder starts your new workspace from your template.
58+
59+
After a few seconds, your workspace is ready to use.
60+
61+
![Workspace is ready](../images/templates/workspace-ready.png)
62+
63+
## 5. Try out your new workspace
64+
65+
This starter template lets you connect to your workspace in a few ways:
66+
67+
- VS Code Desktop: Loads your workspace into
68+
[VS Code Desktop](https://code.visualstudio.com/Download) installed on your
69+
local computer.
70+
- code-server: Opens [browser-based VS Code](../ides/web-ides.md) with your
71+
workspace.
72+
- Terminal: Opens a browser-based terminal with a shell in the workspace's
73+
Docker instance.
74+
- SSH: Use SSH to log in to the workspace from your local machine. If you
75+
haven't already, you'll have to install Coder on your local machine to
76+
configure your SSH client.
77+
78+
> **Tip**: You can edit the template to let developers connect to a workspace in
79+
> [a few more ways](../ides.md).
80+
81+
When you're done, you can stop the workspace. -->
82+
83+
## 6. Modify your template
84+
85+
Now you can modify your template to suit your team's needs.
86+
87+
Let's replace the `golang` package in the Docker image with the `python3`
88+
package. You can do this by editing the template's `Dockerfile` directly in your
89+
web browser.
90+
91+
In the Coder dashboard, select **Templates** then your first template.
92+
93+
![Selecting the first template](../images/templates/select-template.png)
94+
95+
In the drop-down menu, select **Edit files**.
96+
97+
![Edit template files](../images/templates/edit-files.png)
98+
99+
Expand the **build** directory and select **Dockerfile**.
100+
101+
![Selecting source code](../images/templates/source-code.png)
102+
103+
Edit `build/Dockerfile` to replace `golang` with `python3`.
104+
105+
![Editing source code](../images/templates/edit-source-code.png)
106+
107+
Select **Build template** and wait for Coder to prepare the template for
108+
workspaces.
109+
110+
![Building a template](../images/templates/build-template.png)
111+
112+
Select **Publish version**. In the **Publish new version** dialog, make sure
113+
**Promote to default version** is checked then select **Publish**.
114+
115+
![Publish a template](../images/templates/publish.png)
116+
117+
Now when developers create a new workspace from this template, they can use
118+
Python 3 instead of Go.
119+
120+
For developers with workspaces that were created with a previous version of your
121+
template, Coder will notify them that there's a new version of the template.
122+
123+
You can also handle [change management](./change-management.md) through your own
124+
repo and continuous integration.
125+
126+
## Next steps
127+
128+
- [Write your own template](./tour.md)
129+
- [Setting up templates](./best-practices.md)

0 commit comments

Comments
 (0)