Skip to content

Commit ed5da65

Browse files
chore(docs): add Quickstart doc to tutorials (#14744)
New doc to get users up and running quickly preview: https://coder.com/docs/@quickstart-guide/tutorials/quickstart ## To Do - [x] update or remove Codium steps - [x] add to sidebar - [x] add to README and others as needed - [x] reference #11946 and the discussion to influence this PR closes coder/internal#107 --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Muhammad Atif Ali <atif@coder.com>
1 parent d7baa49 commit ed5da65

File tree

10 files changed

+254
-195
lines changed

10 files changed

+254
-195
lines changed

docs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,4 @@ or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq).
143143

144144
- Learn about [Templates](./admin/templates/index.md)
145145
- [Install Coder](./install/index.md)
146+
- Follow the [Quickstart guide](./tutorials/quickstart.md) to try Coder out for yourself.

docs/admin/templates/managing-templates/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Working with templates
22

3-
You create and edit Coder templates as [Terraform](../../../start/coder-tour.md)
4-
configuration files (`.tf`) and any supporting files, like a README or
5-
configuration files for other services.
3+
You create and edit Coder templates as
4+
[Terraform](../../../tutorials/quickstart.md) configuration files (`.tf`) and
5+
any supporting files, like a README or configuration files for other services.
66

77
## Who creates templates?
88

80.1 KB
Loading
Loading
Loading

docs/install/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ coder login https://coder.example.com
6464

6565
## Next steps
6666

67-
- [Set up your first deployment](../start/coder-tour.md)
67+
- [Set up your first deployment](../tutorials/quickstart.md)
6868
- [Expose your control plane to other users](../admin/setup/index.md)

docs/manifest.json

+8-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
"icon_path": "./images/icons/home.svg",
99
"children": [
1010
{
11-
"title": "Tour Coder",
12-
"description": "Tour Coder by creating a deployment with Docker",
13-
"path": "./start/coder-tour.md"
11+
"title": "Coder quickstart",
12+
"description": "Try it out for yourself",
13+
"path": "./tutorials/quickstart.md"
1414
},
1515
{
1616
"title": "Screenshots",
@@ -634,6 +634,11 @@
634634
"path": "./tutorials/index.md",
635635
"icon_path": "./images/icons/generic.svg",
636636
"children": [
637+
{
638+
"title": "Get started with Coder",
639+
"description": "Learn how to install and run Coder quickly",
640+
"path": "./tutorials/quickstart.md"
641+
},
637642
{
638643
"title": "Write a Template from Scratch",
639644
"description": "Learn how to author Coder templates",

docs/start/coder-tour.md

-187
This file was deleted.

docs/tutorials/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Enterprise. These tutorials are hosted on our
66
request new topics to be covered.
77

88
<children>
9-
This page is rendered on https://coder.com/docs/guides. Refer to the other documents in the `guides/` directory for specific employee-written guides.
9+
This page is rendered on <https://coder.com/docs/tutorials>. Refer to the other documents in the `docs/tutorials/` directory for specific employee-written guides.
1010
</children>

0 commit comments

Comments
 (0)