Skip to content

Commit 86064f1

Browse files
author
Katie Horne
authored
chore: update Getting Started landing page (coder#783)
1 parent 378de0b commit 86064f1

File tree

4 files changed

+110
-101
lines changed

4 files changed

+110
-101
lines changed

getting-started/admin.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: Administrators
3+
description: Getting started with Coder as an administrator.
4+
---
5+
6+
This article will walk you through the steps needed to set up, deploy, and
7+
configure Coder so that your developers are ready create their workspaces and
8+
begin working on their projects.
9+
10+
## Set up and deploy Coder
11+
12+
To get started with Coder, you will need to:
13+
14+
1. [Create a Kubernetes cluster](../setup/kubernetes/index.md)
15+
16+
1. [Install Coder via Helm](../setup/installation.md)
17+
18+
Alternatively, [Coder for Docker](../setup/docker.md) allows you to deploy Coder
19+
quickly to machines where you have Docker installed. We recommend this option
20+
for teams with 5-10 developers.
21+
22+
## Configure Coder
23+
24+
Once you've deployed Coder, you'll need to log in and perform the following
25+
configuration steps:
26+
27+
1. [Upload your license file](../setup/configuration.md) (you can get a trial
28+
license for free [here](https://coder.com/trial))
29+
30+
1. Set up [access controls](../admin/access-control/index.md) with OpenID
31+
Connect (OIDC) if you'd like to allow users to register themselves
32+
33+
1. [Create organizations](../admin/organizations/index.md) to manage your user
34+
groups
35+
36+
1. Create an OAuth app for your users to
37+
[connect to your Git provider](../admin/git.md)
38+
39+
1. [Add a container registry](../admin/registries/index.md) for your development
40+
environments to pull from
41+
42+
1. [Import an image](../images/importing.md) with the tools your developers
43+
need. You can [create custom images](../images/writing.md) for your developer
44+
workspaces as well.
45+
46+
## Provision users
47+
48+
To allow developers to access your Coder deployment, you can manually create and
49+
invite users, or you can set up OpenID Connect (OIDC):
50+
51+
- [Azure AD](../guides/admin/oidc-azuread.md)
52+
- [Okta](../guides/admin/oidc-okta.md)
53+
54+
If you are using another Identity Provider (IdP), the process should be very
55+
similar.
56+
57+
With OIDC configured, Coder will automatically create a user and add them to the
58+
[default organization](../admin/organizations/index.md) when a developer logs in
59+
for the first time.
60+
61+
## Automate
62+
63+
You can use the Coder [command-line (CLI) tool](../cli/index.md) to interact
64+
with Coder, as well as the [public API](../guides/api.md) to automate various
65+
tasks through code.
66+
67+
## Maintain and upgrade
68+
69+
Coder releases [upgrades](../setup/upgrade/index.md) on the third Wednesday of
70+
each month, with patch releases published and available as needed.
71+
72+
Coder maintains a public [changelog](../changelog/index.md) and
73+
[release calendar](https://coder.com/release-calendar.ical) to keep you updated
74+
on features, bug fixes, security updates, and breaking changes that are coming.
75+
76+
## Interact with Support
77+
78+
Coder’s standard support is included with your license. You can reach us at
79+
[support@coder.com](mailto:support@coder.com), and one of our engineers will be
80+
able to assist. Please include any relevant logs, error messages, or
81+
screenshots.
82+
83+
Coder also has a [public community Slack](https://cdr.co/join-community) you can
84+
join if you’d like.
85+
86+
Finally, Coder offers premium support through Coder Escalation Services, which
87+
provides a faster response Service-Level Agreement (SLA). Speak to your account
88+
executive if you’re interested in this option.
89+
90+
## Additional information
91+
92+
We encourage you to look through the various [Guides](../guides/index.md) in our
93+
public documentation, as it contains more detailed information on specific use
94+
cases and topics.

getting-started/index.md

Lines changed: 12 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -11,103 +11,15 @@ icon:
1111
---
1212

1313
We’re excited for you to be part of the growing community of Coder users, and we
14-
wanted to provide an onboarding guide to ensure you have a great experience.
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.
17-
18-
If you're participating in our hosted beta, please see our
19-
[guide on getting started](guides/hosted-beta/index.md). If you're deploying
20-
Coder to your own clusters, please proceed with this article.
21-
22-
## Set up and deploy Coder
23-
24-
To get started with Coder, you’ll need to [deploy Coder](./setup/index.md) to a
25-
Kubernetes cluster. We have documentation to help you
26-
[create a cluster](./setup/kubernetes/index.md) if needed. Once you have a
27-
cluster, you can [install Coder via Helm](./setup/installation.md).
28-
29-
## Configure Coder
30-
31-
After you deploy Coder, you’ll need to
32-
[upload your license file](./setup/configuration.md) before you can configure
33-
the application (you can get a trial license for free
34-
[here](https://coder.com/trial)). Once logged in, you’ll be able to access the
35-
[administration management](./admin/index.md) menu to set up things such as
36-
[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC),
37-
[create organizations](./admin/organizations/index.md), and create an OAuth app
38-
for your users to [connect to your Git provider](./admin/git.md).
39-
40-
At a minimum, you’ll want to ensure you
41-
[add a container registry](./admin/registries/index.md) for your development
42-
environments to pull from, and [import an image](./images/importing.md) with the
43-
tools your developers need. You can [create custom images](./images/writing.md)
44-
for your developer workspaces as well.
45-
46-
## Provision users
47-
48-
With some base configuration done, you’ll want to allow your developers to begin
49-
using Coder. You can manually create and invite users, or you can set up OpenID
50-
Connect (OIDC) with [Azure AD](./guides/admin/oidc-azuread.md) or
51-
[Okta](./guides/admin/oidc-okta.md). If you are using another Identity Provider
52-
(IdP), the process should be very similar. With OIDC configured, Coder will
53-
automatically create a user and add them to the
54-
[default organization](./admin/organizations/index.md) when a developer logs in
55-
for the first time.
56-
57-
## Automate
58-
59-
Coder has a [command-line (CLI) tool](./cli/index.md) that you and your
60-
developers may be interested in using to interact with Coder. The CLI is
61-
completely [open-sourced](https://github.com/cdr/coder-cli), and we always
62-
welcome contributions. Additionally, Coder has a [public API](./guides/api.md)
63-
that you can use to automate various tasks through code.
64-
65-
## Connect local IDEs
66-
67-
While Coder supports a
68-
[variety of IDEs in the browser](https://coder.com/docs/coder/v1.20/workspaces/editors),
69-
such as VSCode and the JetBrains product suite, some developers may want to use
70-
their local installation of these tools or other IDEs with Coder. By leveraging
71-
the [Coder CLI](./cli/index.md), developers will be able to
72-
[connect their terminal](./cli/remote-terminal.md) to the remote environment’s
73-
terminal, and enable [file sync](./cli/file-sync.md) to have their local
74-
directory’s tree sync with the remote file system.
75-
76-
## Maintain and update
77-
78-
Coder maintains a public [changelog](./changelog/index.md) and
79-
[release calendar](https://coder.com/release-calendar.ical) to help you stay in
80-
the know on features, bug fixes, security updates, and breaking changes that are
81-
coming. Coder releases are available on the third Wednesday of each month, and
82-
patch releases are published and available as needed.
83-
84-
## Interact with Support
85-
86-
Coder’s standard support is included with your license. You can reach us at
87-
[support@coder.com](mailto:support@coder.com), and one of our engineers will be
88-
able to assist. Please include any relevant logs, error messages, or
89-
screenshots.
90-
91-
Coder also has a [public community Slack](https://cdr.co/join-community) you can
92-
join if you’d like.
93-
94-
Finally, Coder offers premium support through Coder Escalation Services, which
95-
provides a faster response Service-Level Agreement (SLA). Speak to your account
96-
executive if you’re interested in this option.
97-
98-
## Additional information
99-
100-
There are a variety of ways to follow Coder to stay up-to-date on company
101-
updates, whitepapers, blog posts, and more.
102-
103-
- [Coder Blog](https://coder.com/blog)
104-
- [Videos about Coder](https://coder.com/resources/videos)
105-
- [Whitepapers](https://coder.com/resources/whitepapers)
106-
- Social media accounts such as
107-
[LinkedIn](https://www.linkedin.com/company/coderhq),
108-
[YouTube](https://www.youtube.com/channel/UCWexK_ECcUU3vEIdb-VYkfw),
109-
[Twitter](https://twitter.com/coderhq), and others
110-
111-
Finally, we encourage you to look through the various
112-
[Guides](./guides/index.md) in our public documentation, as it contains more
113-
detailed information on specific use cases and topics.
14+
wanted to provide this onboarding guide to help you get started.
15+
16+
If you've been tasked with deploying and configuring Coder, please see our
17+
[admin](admin.md) guide for a high-level overview of what you need to do so that
18+
your developers can create their workspaces and begin working on their projects.
19+
20+
There are two primary ways of deploying Coder, and we offer developer-oriented
21+
guides for both [Kubernetes deployments](developers.md) and
22+
[deployments using Coder for Docker](docker.md). Once developers have a Coder
23+
deployment available to them, these end-to-end guides will walk them through
24+
logging in and getting set up with a sample project they can use to experience
25+
Coder.

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ enterprise security.
2020
Welcome to your new computer in the cloud.
2121
</p>
2222

23-
<a href="./workspaces/getting-started.md">
23+
<a href="./getting-started/index.md">
2424
<button class="arrow">
2525
Get started
2626
</button>

manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
{
3030
"path": "getting-started/index.md",
3131
"children": [
32+
{
33+
"path": "getting-started/admin.md"
34+
},
3235
{
3336
"path": "getting-started/developers.md"
3437
},

0 commit comments

Comments
 (0)