- Notifications
You must be signed in to change notification settings - Fork1k
chore: update quickstart (docs)#2381
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Binary file addeddocs/images/code-server.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletionsdocs/install.md
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
28 changes: 22 additions & 6 deletionsdocs/quickstart.md
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 |
---|---|---|
@@ -1,6 +1,10 @@ | ||
# Quickstart | ||
This guide will walk you through creating your first template and workspace. | ||
## Prerequisites | ||
Please [install Coder](./install.md) before proceeding with the steps outlined in this article. | ||
## Creating your first template and workspace | ||
@@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template: | ||
coder templates init | ||
``` | ||
Follow the CLI instructions to select an example that you can modify for your | ||
specific usage (e.g., a template to **Develop code-server in Docker**): | ||
1. Navigate into your new templates folder and create your first template using | ||
the provided command (e.g., `cd ./docker-code-server && coder templates create`) | ||
1. Answer the CLI prompts; when done, confirm that you want to create your template. | ||
Create a workspace using your template: | ||
@@ -25,13 +34,20 @@ Connect to your workspace via SSH: | ||
coder ssh <workspaceName> | ||
``` | ||
You can also access your workspace using the **access URL** you provided when | ||
deploying Coder (if you're using a temporary deployment and you opted to use | ||
Coder's tunnel, use the access URL you were provided). Log in with the admin | ||
credentials provided to you by Coder. | ||
khorne3 marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
 | ||
## Modifying templates | ||
Youcan edit the Terraform templateas follows: | ||
```sh | ||
coder templates init | ||
cd gcp-linux # modify this line as needed to access the template | ||
vim main.tf | ||
coder templates update gcp-linux # updates the template | ||
``` |
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.