Skip to content

docs: restructure docs #14182

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

Closed
wants to merge 96 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
96 commits
Select commit Hold shift + click to select a range
13d4f56
docs offsite day 1
bpmct May 22, 2024
3cf73ed
updated coder tour and screenshots
stirby May 23, 2024
5bcaf81
edit manifest
bpmct May 23, 2024
e97dcba
incomplete info on schedule
stirby May 23, 2024
1352640
changes
bpmct May 23, 2024
56ef29e
rebase on `main`
matifali Aug 6, 2024
d9b2b76
removed stub on coder tour
stirby May 23, 2024
de4599c
workspace README page and tour cleanup
stirby May 23, 2024
2c277df
fixed tour MD linksg
stirby May 23, 2024
ad4bb0c
replaced broken pngs
stirby May 23, 2024
920ac48
moved workspace access to a directory
stirby May 23, 2024
133721a
rebase on `main`
matifali Aug 6, 2024
762b680
workspace access docs
stirby May 23, 2024
f74f54d
user guides manifest
stirby May 23, 2024
eab79b3
rebase on `main`
matifali Aug 6, 2024
af700c3
vscode
stirby May 23, 2024
442b6fd
add schedule
bpmct May 23, 2024
c4de546
title case for user guides
stirby May 24, 2024
248bbc2
workspace scheduling
stirby May 24, 2024
48bdc86
added workspace updating to main user guide
stirby May 24, 2024
39185ed
dotfiles page done
stirby May 24, 2024
0cc2d32
fleshed out vscode page
stirby May 24, 2024
bec25cb
weekend
stirby May 26, 2024
79ee974
templates
bpmct May 24, 2024
a3f2e84
integrations
stirby May 26, 2024
c0784a4
removed other platforms page
stirby May 26, 2024
1753902
cleanup
stirby May 29, 2024
90d92e1
some reorg and writing
bpmct May 27, 2024
03f5a93
migrated guides to tutorials
stirby May 30, 2024
ee2c576
infrastructure landing page
bpmct Jun 8, 2024
2dcf91e
add guide for creating templates
bpmct Jun 8, 2024
1907108
new format
bpmct Jun 8, 2024
1215e22
consider linking to tf
bpmct Jun 8, 2024
ca1a458
install landing page
bpmct Jun 8, 2024
9b55009
post pto sync
stirby Jun 12, 2024
6267964
in flight admin-workspace changes
stirby Jun 12, 2024
13716a1
fixing images in about page
stirby Jun 12, 2024
17fcea1
reference/cli proper structure
bpmct Jun 15, 2024
fc159ce
rebase on `main`
matifali Aug 6, 2024
330132b
rebase on `main`
matifali Aug 6, 2024
1efad16
fixups for cli and api gen
bpmct Jun 15, 2024
215a3ac
modify to look for Command Line nested in manifest
bpmct Jun 15, 2024
0041e8c
rebase on `main`
matifali Aug 6, 2024
822130a
wip
matifali Aug 6, 2024
293e07c
wip
matifali Aug 6, 2024
259668b
add screenshots
bpmct Jun 15, 2024
bcfe8ba
workspace lifecycle WIP
stirby Jun 20, 2024
dd73049
added workspace lifecycle to manifest for preview
stirby Jun 20, 2024
d6f2a8c
moved resource definition outside of user guides
stirby Jun 20, 2024
15592cb
fixed manifext typo
stirby Jun 20, 2024
875274d
rough draft of workspace lifecycle
stirby Jun 20, 2024
ce0cd54
cleaned up user guide for workspace scheduling
stirby Jun 20, 2024
d47245b
linked workspace scheduling guide in workspace lifecycle
stirby Jun 20, 2024
bc7db22
started 'extending templates' rearranged resource persistence
stirby Jun 22, 2024
2da48b9
copied secrets.md under admin/security
stirby Jun 24, 2024
5d07ed9
wip
matifali Aug 6, 2024
1235238
partial completion of admin/templates/extending-templates
stirby Jun 24, 2024
22c4a55
additional extending templates refactors
stirby Jun 24, 2024
8add1d7
finished 'extending templates' with variables.md from old docs
stirby Jun 24, 2024
51365cd
added manifest for extending templates
stirby Jun 24, 2024
3a46ccd
added secrets to manifest
stirby Jun 24, 2024
6c269eb
added FAQs as a subsection of guides. Going to keep them for now.
stirby Jul 19, 2024
9ac4f3f
migrated networking docs
stirby Jul 19, 2024
cf13803
added control plane configuration docs
stirby Jul 19, 2024
4098a8c
add integration guides
matifali Aug 6, 2024
34b2ed6
fix manifest
matifali Aug 6, 2024
5ca11b0
fmt and typos
matifali Aug 6, 2024
1447aea
fixup!
matifali Aug 6, 2024
d00cc9b
fix some links
matifali Aug 6, 2024
cafa035
fixup!
matifali Aug 6, 2024
7963a1a
`make fmt`
matifali Aug 6, 2024
aa7d43c
`make gen`
matifali Aug 6, 2024
adfc34c
`make fmt`
matifali Aug 6, 2024
1d21c9a
fixup!
matifali Aug 6, 2024
5f5b3d9
fix capitalization
matifali Aug 6, 2024
4e43821
add scaling to manifest
matifali Aug 6, 2024
0d20438
fix link
matifali Aug 6, 2024
0763b35
rebase on `main`
matifali Aug 7, 2024
bf5535c
rebase on `main`
matifali Aug 7, 2024
2e4b218
fmt and typos
matifali Aug 6, 2024
0996219
`make fmt`
matifali Aug 7, 2024
990d440
`make gen`
matifali Aug 7, 2024
66ff05e
chore: bump github.com/ory/dockertest/v3 from 3.10.0 to 3.11.0 (#14237)
dependabot[bot] Aug 12, 2024
3b099fd
added workspace proxies from lost branch
stirby Aug 13, 2024
2f14a08
chore(docs): move scaling docs under admin/infrastructure (#14270)
stirby Aug 15, 2024
ad16573
chore(docs): add WebRDP to restructure docs (#14385)
stirby Aug 21, 2024
579778e
wip
matifali Aug 22, 2024
e8eb3e4
fixup!
matifali Aug 22, 2024
4b9c2c6
fmt
matifali Aug 22, 2024
01707ec
add snap
matifali Aug 22, 2024
e034239
fixup!
matifali Aug 22, 2024
c021161
fix IDEs mess
matifali Aug 22, 2024
3ef9932
fmt
matifali Aug 23, 2024
d3b4b78
link change management
matifali Aug 23, 2024
18a498d
add terraform modules
matifali Aug 23, 2024
801d4fa
delete filebrowser
matifali Aug 23, 2024
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
updated coder tour and screenshots
  • Loading branch information
stirby authored and matifali committed Aug 12, 2024
commit 3cf73edda3ae20a957a7b84d1c33886863428e22
Binary file added docs/images/start/build-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/start/first-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/start/template-edit-source-code.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/start/template-publish.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/start/template-source-code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
95 changes: 54 additions & 41 deletions docs/start/coder-tour.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
## Tour Coder and Set up your first deployment.
# Tour Coder and with your first deployment

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

We'll use [Docker](https://docs.docker.com/engine) to manage the compute for a
slim deployment to experiment with
[workpsaces](../tutorials/workspaces/README.md) and
[templates](../tutorials/templates/README.md).

Docker is not necessary for every Coder deployment and is only used here for
simplicity.
slim deployment.

# Set up your Coder Deployment

## 1. Install Docker
### 1. Install Docker

First, install [Docker](https://docs.docker.com/engine/install/) locally.
First, install [Docker](https://docs.docker.com/engine/install) locally.

> If you already have the Coder binary installed, restart it after installing
> Docker.

## 2. Install Coder daemon
### 2. Install Coder daemon

A single binary contains the CLI (`coder`) and is used for both the Coder server and the client.

<div class="tabs">

Expand All @@ -36,11 +33,6 @@ curl -L https://coder.com/install.sh | sh

## Windows

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

You can use the
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)
package manager to install Coder:
Expand All @@ -49,9 +41,17 @@ package manager to install Coder:
winget install Coder.Coder
```

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


</div>

## 3. Start the server
> See our [install docs](../install/README.md) for other methods of installing and deploying Coder.

### 3. Start the server

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

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

### More information on the Coder Server

# Create your first template
> To learn more about interacting with the control plane through the terminal, see our `coder server` [CLI docs](../cli/server.md).

## Create your first template

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
Expand All @@ -78,10 +79,12 @@ template is up and running, you can edit it in the Coder dashboard. Coder even
handles versioning for you so you can publish official updates or revert to
previous versions.

> Read more about templates in our [tutorials section](../tutorials/templates.md).

In this tutorial, you'll create your first template from the Docker starter
template.

## 1. Choose a starter template
### 1. Choose a starter template

Select **Templates** to see the **Starter Templates**. Use the **Docker
Containers** template by pressing **Use Template**.
Expand All @@ -91,23 +94,28 @@ Containers** template by pressing **Use Template**.
> You can also a find a comprehensive list of starter templates in **Templates**
> -> **Create Template** -> **Starter Templates**.

## 2. Create your template
### 2. Create your template

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

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

TODO:

- add CLI guide for making a new template
- refactor text below to be more beginner-friendly
### Other template resources
- [Templates overview](../tutorials/templates/README.md)
- [Create templates through the CLI](../cli/templates_create.md)
- See our [Community Templates](https://github.com/coder/coder/blob/main/examples/templates/community-templates.md) in Github
- Create a template from a [Dev Container](../templates/dev-containers.md)

# Create a workspace

## 1. Create a workspace from your template
Coder workspaces are the primary interface for end-users. Each workspace is defined by a template, but can be modified with parameters and settings. The easiest way to create a workspace is through the template GUI.

> Read more about templates in our [tutorials section](../tutorials/workspaces.md).

### 1. Create a workspace from your template

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

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

Expand All @@ -122,7 +130,7 @@ After a few seconds, your workspace is ready to use.

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

## 4. Try out your new workspace
### 2. Try out your new workspace

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

Expand All @@ -142,7 +150,11 @@ This starter template lets you connect to your workspace in a few ways:

When you're done, you can stop the workspace.

## 6. Modify your template

## Expand your configuration


### Modify your template

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

Expand All @@ -152,29 +164,26 @@ web browser.

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

![Selecting the first template](../images/templates/select-template.png)
![Selecting the first template](../images/start/first-template.png)

In the drop-down menu, select **Edit files**.
In the this view, select **Source Code** to view and edit the template files.

![Edit template files](../images/templates/edit-files.png)
![Edit template files](../images/start/template-source-code.png)

Expand the **build** directory and select **Dockerfile**.

![Selecting source code](../images/templates/source-code.png)
Click the **Edit** button at the top-right of the `build/Dockerfile` to open the in-browser editor then replace `golang` with `python3`.

Edit `build/Dockerfile` to replace `golang` with `python3`.

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

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

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

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

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

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

You can also handle [change management](./change-management.md) through your own
repo and continuous integration.


### Next Steps
- TODO