-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: update Get Started Page to Include Tasks #19752
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
Merged
+164
−50
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
c2a8591
Update quickstart docker and coder install steps
david-fraley cde865d
rest of quickstart
david-fraley a69b0fb
start of tasks docs
david-fraley 3ff6dac
continued work on tasks
david-fraley a99a6e5
Updated tasks quickstart section
david-fraley b74cef8
docs: fix markdown formatting issues in quickstart.md
blink-so[bot] 5d943d7
add back whats next
david-fraley 0d406fd
docs: fix typos and formatting in quickstart.md
blink-so[bot] a5fdcdd
docs: format quickstart.md with prettier
blink-so[bot] e3ec375
docs: format markdown tables in quickstart.md
blink-so[bot] c349ac0
Update tasks how-to
david-fraley 0e1984d
add pic, remove keywords
david-fraley a211e2a
add note about docker running in background
david-fraley 62ef23a
added picture for changing directories
david-fraley 4e4d27e
revert title change. it'll come later
david-fraley a0502e6
Merge branch 'main' into david-fraley/update-quickstart
david-fraley 91cb305
minor nit
david-fraley 8dc67ae
updated concepts section
david-fraley 4ef89f0
format
david-fraley 302079d
more format
david-fraley 5ef4945
Fix typo
david-fraley 018f7db
more formats
david-fraley 9bc326e
docs: fix trailing whitespace in quickstart.md
blink-so[bot] dbe130a
docs: add missing newline at end of quickstart.md
blink-so[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
rest of quickstart
- Loading branch information
commit cde865d0ff3d42ff4907a077c76d891e0a65d438
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -120,45 +120,57 @@ is installed. | |
|
||
</div> | ||
|
||
Coder will attempt to open the setup page in your browser. If it doesn't open | ||
automatically, go to <http://localhost:3000>. | ||
|
||
## Configure Coder with a new Workspace | ||
- If you get a browser warning similar to `Secure Site Not Available`, you | ||
can ignore the warning and continue to the setup page. | ||
|
||
1. Coder will attempt to open the setup page in your browser. If it doesn't open | ||
automatically, go to <http://localhost:3000>. | ||
If your Coder server is on a network or cloud device, or you are having | ||
trouble viewing the page, locate the web UI URL in Coder logs in your | ||
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. | ||
It's one of the first lines of output, so you might have to scroll up to find | ||
it. | ||
|
||
- If you get a browser warning similar to `Secure Site Not Available`, you | ||
can ignore the warning and continue to the setup page. | ||
## Step 3: Initial Setup | ||
|
||
If your Coder server is on a network or cloud device, or you are having | ||
trouble viewing the page, locate the web UI URL in Coder logs in your | ||
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. | ||
It's one of the first lines of output, so you might have to scroll up to find | ||
it. | ||
1. **Create your admin account:** | ||
- Username: `yourname` (lowercase, no spaces) | ||
- Email: `[email protected]` | ||
- Password: Choose a strong password | ||
|
||
1. On the **Welcome to Coder** page, to use your GitHub account to log in, | ||
select **Continue with GitHub**. | ||
You can also enter an email and password to create a new admin account on | ||
the Coder deployment: | ||
You can also choose to **Continue with GitHub** instead of creating an admin account | ||
|
||
_Welcome | ||
to Coder - Create admin user_ | ||
 | ||
|
||
1. On the **Workspaces** page, select **Go to templates** to create a new | ||
template. | ||
## Step 4: Create your First Template and Workspace | ||
|
||
1. For this guide, use a Docker container. Locate **Docker Containers** and | ||
select **Use template**. | ||
Templates define what's in your development environment. Let's start simple: | ||
|
||
1. Give the template a **Name** that you'll recognize both in the Coder UI and | ||
in command-line calls. | ||
1. Click **"Templates"** → **"New Template"** | ||
|
||
The rest of the template details are optional, but will be helpful when you | ||
have more templates. | ||
2. **Choose a starter template:** | ||
|
||
_Create | ||
template_ | ||
| Starter | Best For | Includes | | ||
|---------|----------|----------| | ||
| **Docker Containers** (Recommended) | Getting started quickly, local development, prototyping | Ubuntu container with common dev tools, Docker runtime | | ||
| **Kubernetes (Deployment)** | Cloud-native teams, scalable workspaces | Pod-based workspaces, Kubernetes orchestration | | ||
| **AWS EC2 (Linux)** | Teams needing full VMs, AWS-native infrastructure | Full EC2 instances with AWS integration | | ||
|
||
1. Select **Save**. | ||
3. Click **"Use template"** on **Docker Containers** | ||
david-fraley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
4. **Name your template:** | ||
- Name: `quickstart` | ||
- Display name: `quickstart doc template` | ||
- Description: `Provision Docker containers as Coder workspaces` | ||
|
||
 | ||
|
||
5. Click **"Save"** | ||
|
||
**What just happened?** You defined a template — a reusable blueprint for dev environments — in your Coder deployment. It’s now stored in your organization’s template list, where you and any teammates in the same org can create workspaces from it. Let’s launch one. | ||
|
||
## Step 5: Launch your Workspace | ||
|
||
1. After the template is ready, select **Create Workspace**. | ||
|
||
|
@@ -169,10 +181,9 @@ is installed. | |
_Workspace | ||
is running_ | ||
|
||
1. Select **VS Code Desktop** to install the Coder extension and connect to your | ||
Coder workspace. | ||
## Step 6: Connect your IDE | ||
|
||
## Work on some code | ||
Select **VS Code Desktop** to install the Coder extension and connect to your Coder workspace. | ||
|
||
After VS Code loads the remote environment, you can select **Open Folder** to | ||
david-fraley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
explore directories in the Docker container or work on something new. | ||
|
@@ -196,19 +207,17 @@ To clone an existing repository: | |
|
||
1. You are now using VS Code in your Coder environment! | ||
|
||
## What's next? | ||
|
||
Now that you have your own workspace, use the same template to set one up for a | ||
teammate. | ||
## Success! You're Coding in Coder | ||
|
||
Go to **Templates** and select **Create Workspace** and continue from Step 7 in | ||
[Configure Coder with a new workspace](#configure-coder-with-a-new-workspace). | ||
You now have: | ||
- **Coder server** running locally | ||
- **A template** defining your environment | ||
- **A workspace** running that environment | ||
- **IDE access** to code remotely | ||
|
||
After that, you can try to: | ||
### Get Coder Tasks Running | ||
david-fraley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [Customize templates](../admin/templates/extending-templates/index.md) | ||
- [Enable Prometheus metrics](../admin/integrations/prometheus.md) | ||
- [Deploy to Google Cloud Platform (GCP)](../install/cloud/compute-engine.md) | ||
tbd @david | ||
|
||
## Troubleshooting | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.