Skip to content

Commit 2711984

Browse files
bpmctKatie Horne
bpmct
and
Katie Horne
authored
refresh custom images guides in docs (coder#588)
* refresh images flow in docs * Edit text; fix links Co-authored-by: Katie Horne <katie@coder.com>
1 parent 1f925a4 commit 2711984

File tree

6 files changed

+72
-280
lines changed

6 files changed

+72
-280
lines changed

‎getting-started.md

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,43 @@
11
---
22
title: "Getting started"
33
description: Get started with Coder.
4-
icon: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" viewBox="0 0 16 16" width="16" xml:space="preserve"><path d="M1 2a1 1 0 0 1 1-1h11a1 1 0 0 1 1 1v1h.5A1.5 1.5 0 0 1 16 4.5v7a1.5 1.5 0 0 1-1.5 1.5h-.55a2.5 2.5 0 0 1-2.45 2h-8A2.5 2.5 0 0 1 1 12.5V2zm13 10h.5a.5.5 0 0 0 .5-.5v-7a.5.5 0 0 0-.5-.5H14v8z"/></svg>'
4+
icon:
5+
'<svg xmlns="http://www.w3.org/2000/svg"
6+
xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" viewBox="0 0 16 16"
7+
width="16" xml:space="preserve"><path d="M1 2a1 1 0 0 1 1-1h11a1 1 0 0 1 1
8+
1v1h.5A1.5 1.5 0 0 1 16 4.5v7a1.5 1.5 0 0 1-1.5 1.5h-.55a2.5 2.5 0 0 1-2.45
9+
2h-8A2.5 2.5 0 0 1 1 12.5V2zm13 10h.5a.5.5 0 0 0 .5-.5v-7a.5.5 0 0
10+
0-.5-.5H14v8z"/></svg>'
511
---
612

713
We’re excited for you to be part of the growing community of Coder users, and we
814
wanted to provide an onboarding guide to ensure you have a great experience.
9-
Coder’s [documentation is publicly editable](https://github.com/cdr/docs),
10-
so please feel free to contribute and provide feedback as you desire.
15+
Coder’s [documentation is publicly editable](https://github.com/cdr/docs), so
16+
please feel free to contribute and provide feedback as you desire.
1117

1218
## Setup and deploy Coder
1319

1420
To get started with Coder, you’ll need to [deploy Coder](./setup/index.md) to a
15-
Kubernetes cluster. We have documentation to help you [create a
16-
cluster](./setup/kubernetes/index.md) if needed. Once you have a cluster, you
17-
can [install Coder via Helm](./setup/installation.md).
21+
Kubernetes cluster. We have documentation to help you
22+
[create a cluster](./setup/kubernetes/index.md) if needed. Once you have a
23+
cluster, you can [install Coder via Helm](./setup/installation.md).
1824

1925
## Configure Coder
2026

21-
After you deploy Coder, you’ll need to [upload your license
22-
file](./setup/configuration.md) before you can configure the application (you
23-
can get a trial license for free [here](https://coder.com/trial)). Once logged
24-
in, you’ll be able to access the [administration management](./admin/index.md)
25-
menu to set up things such as [access
26-
controls](./admin/access-control/index.md) with OpenID Connect (OIDC),
27+
After you deploy Coder, you’ll need to
28+
[upload your license file](./setup/configuration.md) before you can configure
29+
the application (you can get a trial license for free
30+
[here](https://coder.com/trial)). Once logged in, you’ll be able to access the
31+
[administration management](./admin/index.md) menu to set up things such as
32+
[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC),
2733
[create organizations](./admin/organizations.md), and create an OAuth app for
2834
your users to [connect to your Git provider](./admin/git.md).
2935

30-
At a minimum, you’ll want to ensure you [add a container
31-
registry](./admin/registries/index.md) for your development environments to pull
32-
from, and [import an image](./images/importing.md) with the tools your
33-
developers need. You can [create custom
34-
images](./guides/customization/custom-workspace.md) for your developer
35-
workspaces as well.
36+
At a minimum, you’ll want to ensure you
37+
[add a container registry](./admin/registries/index.md) for your development
38+
environments to pull from, and [import an image](./images/importing.md) with the
39+
tools your developers need. You can [create custom images](images/writing.md)
40+
for your developer workspaces as well.
3641

3742
## Provision users
3843

@@ -41,9 +46,9 @@ using Coder. You can manually create and invite users, or you can set up OpenID
4146
Connect (OIDC) with [Azure AD](./guides/admin/oidc-azuread.md) or
4247
[Okta](./guides/admin/oidc-okta.md). If you are using another Identity Provider
4348
(IdP), the process should be very similar. With OIDC configured, Coder will
44-
automatically create a user and add them to the [default
45-
organization](./admin/organizations.md) when a developer logs in for the first
46-
time.
49+
automatically create a user and add them to the
50+
[default organization](./admin/organizations.md) when a developer logs in for
51+
the first time.
4752

4853
## Automate
4954

@@ -55,22 +60,22 @@ that you can use to automate various tasks through code.
5560

5661
## Connect local IDEs
5762

58-
While Coder supports a [variety of IDEs in the
59-
browser](https://coder.com/docs/coder/v1.20/workspaces/editors), such as VSCode
60-
and the JetBrains product suite, some developers may want to use their local
61-
installation of these tools or other IDEs with Coder. By leveraging the [Coder
62-
CLI](./cli/index.md), developers will be able to [connect their
63-
terminal](./cli/remote-terminal.md) to the remote environment’s terminal, and
64-
enable [file sync](./cli/file-sync.md) to have their local directory’s tree sync
65-
with the remote file system.
63+
While Coder supports a
64+
[variety of IDEs in the browser](https://coder.com/docs/coder/v1.20/workspaces/editors),
65+
such as VSCode and the JetBrains product suite, some developers may want to use
66+
their local installation of these tools or other IDEs with Coder. By leveraging
67+
the [Coder CLI](./cli/index.md), developers will be able to
68+
[connect their terminal](./cli/remote-terminal.md) to the remote environment’s
69+
terminal, and enable [file sync](./cli/file-sync.md) to have their local
70+
directory’s tree sync with the remote file system.
6671

6772
## Maintain and update
6873

69-
Coder maintains a public [changelog](./changelog/index.md) and [release
70-
calendar](https://coder.com/release-calendar.ical) to help you stay in the know
71-
on features, bug fixes, security updates, and breaking changes that are coming.
72-
Coder releases are available on the third Wednesday of each month, and patch
73-
releases are published and available as needed.
74+
Coder maintains a public [changelog](./changelog/index.md) and
75+
[release calendar](https://coder.com/release-calendar.ical) to help you stay in
76+
the know on features, bug fixes, security updates, and breaking changes that are
77+
coming. Coder releases are available on the third Wednesday of each month, and
78+
patch releases are published and available as needed.
7479

7580
## Interact with Support
7681

‎guides/customization/custom-workspace.md

Lines changed: 0 additions & 218 deletions
This file was deleted.

‎images/configure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Configure"
2+
title: "Configure script"
33
description: Learn how to configure Coder's workspace startup behavior.
44
---
55

0 commit comments

Comments
 (0)