-
Notifications
You must be signed in to change notification settings - Fork 81
Add Getting Started Doc #458
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
Merged
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e18ae30
Initial getting-started doc
IAmHughes 981cc2c
Hopefully fix linting
IAmHughes dc4cc26
Edit text and add to manifest
ac82d5a
Update getting-started.md
IAmHughes 0991bb4
Add icon
d9caa2d
Merge branch 'IAmHughes/add-getting-started' of https://github.com/cd…
fedafc7
Update icon; lint
6543e6c
Apply changes based on review
5073243
Fix link formatting issue
IAmHughes e581a78
Apply suggestions from code review
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
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 |
---|---|---|
@@ -0,0 +1,104 @@ | ||
--- | ||
title: "Getting started" | ||
description: Get started with Coder. | ||
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>' | ||
--- | ||
|
||
We’re excited for you to be part of the growing community of Coder users, and we | ||
wanted to provide an onboarding guide to ensure you have a great experience. | ||
Coder’s [documentation is completely open-source](https://github.com/cdr/docs), | ||
so please feel free to contribute and provide feedback as you desire. | ||
|
||
## Setup and deploy Coder | ||
|
||
To get started with Coder, you’ll need to [deploy Coder](./setup/index.md) to a | ||
Kubernetes cluster. We have documentation to help you [create a | ||
cluster](./setup/kubernetes/index.md) if needed. Once you have a cluster, you | ||
can [install Coder via Helm](./setup/installation.md). | ||
|
||
## Configure Coder | ||
|
||
After you deploy Coder, you’ll need to [upload your license | ||
file](./setup/configuration.md) before you can configure the application (you | ||
can get a trial license for free [here](https://coder.com/trial)). Once logged | ||
in, you’ll be able to access the [administration management](.//admin/index.md) | ||
khorne3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
menu to set up things such as [access | ||
controls](](.//admin/access-control/index.md) with OpenID Connect (OIDC), | ||
IAmHughes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[create organizations](./admin/organizations.md), and create an OAuth app for | ||
your users to [connect to your Git provider](./admin/git.md). | ||
|
||
At a minimum, you’ll want to ensure you [add a container | ||
registry](./admin/registries/index.md) for your development environments to pull | ||
from, and [import an image](./images/importing.md) with the tools your | ||
developers need. You can [create custom | ||
images](./guides/customization/custom-workspace.md) for your developer | ||
workspaces as well. | ||
|
||
## Provision users | ||
|
||
With some base configuration done, you’ll want to allow your developers to begin | ||
using Coder. You can manually create and invite users, or you can set up OpenID | ||
Connect (OIDC) with [Azure AD](./guides/admin/oidc-azuread.md) or | ||
[Okta](./guides/admin/oidc-okta.md). If you are using another Identity Provider | ||
(IdP), the process should be very similar. With OIDC configured, Coder will | ||
automatically create a user and add them to the [default | ||
organization](./admin/organizations.md) when a developer logs in for the first | ||
time. | ||
|
||
khorne3 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Automate | ||
|
||
Coder has a [command-line (CLI) tool](./cli/index.md) that you and your | ||
developers may be interested in using to interact with Coder. The CLI is | ||
completely [open-sourced](https://github.com/cdr/coder-cli), and we always | ||
welcome contributions. Additionally, Coder has a [public API](./guides/api.md) | ||
that you can use to automate various tasks through code. | ||
IAmHughes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Connect local IDEs | ||
|
||
While Coder supports a [variety of IDEs in the | ||
browser](https://coder.com/docs/coder/v1.20/workspaces/editors), such as VSCode | ||
and the JetBrains product suite, some developers may want to use their local | ||
installation of these tools or other IDEs with Coder. By leveraging the [Coder | ||
CLI](./cli/index.md), developers will be able to [connect their | ||
terminal](./cli/remote-terminal.md) to the remote environment’s terminal, and | ||
enable [file sync](./cli/file-sync.md) to have their local directory’s tree sync | ||
with the remote file system. | ||
|
||
## Maintain and update | ||
|
||
Coder maintains a public [changelog](./changelog/index.md) and [release | ||
calendar](https://coder.com/release-calendar.ical) to help you stay in the know | ||
on features, bug fixes, security updates, and breaking changes that are coming. | ||
Coder releases are available on the third Wednesday of each month, and patch | ||
releases are published and available as needed. | ||
|
||
## Interact with Support | ||
|
||
Coder’s standard support is included with your license. You can reach us at | ||
[support@coder.com](mailto:support@coder.com), and one of our engineers will be | ||
able to assist. Please include any relevant logs, error messages, or | ||
screenshots. | ||
|
||
Coder also has a [public community Slack](https://cdr.co/join-community) you can | ||
join if you’d like. | ||
|
||
Finally, Coder offers premium support through Coder Escalation Services, which | ||
provides a faster response Service-Level Agreement (SLA). Speak to your account | ||
executive if you’re interested in this option. | ||
|
||
## Additional information | ||
|
||
There are a variety of ways to follow Coder to stay up-to-date on company | ||
updates, whitepapers, blog posts, and more. | ||
|
||
- [Coder Blog](https://coder.com/blog) | ||
- [Videos about Coder](https://coder.com/resources/videos) | ||
- [Whitepapers](https://coder.com/resources/whitepapers) | ||
- Social media accounts such as | ||
[LinkedIn](https://www.linkedin.com/company/coderhq), | ||
[YouTube](https://www.youtube.com/channel/UCWexK_ECcUU3vEIdb-VYkfw), | ||
[Twitter](https://twitter.com/coderhq), and others | ||
|
||
Finally, we encourage you to look through the various | ||
[Guides](./guides/index.md) in our public documentation, as it contains more | ||
detailed information on specific use cases and topics. |
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 |
---|---|---|
|
@@ -15,6 +15,9 @@ | |
} | ||
] | ||
}, | ||
{ | ||
"path": "getting-started.md" | ||
}, | ||
{ | ||
"path": "./workspaces/index.md", | ||
"children": [ | ||
|
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.