From 12d9312e0836e1a164e4d175e2d3c6695bc93a06 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Thu, 6 Jan 2022 08:41:53 -0600 Subject: [PATCH 1/5] update manifest --- getting-started/admin.md | 94 ++++++++++++++++++++++++++++++++ getting-started/index.md | 112 +++++---------------------------------- manifest.json | 3 ++ 3 files changed, 109 insertions(+), 100 deletions(-) create mode 100644 getting-started/admin.md diff --git a/getting-started/admin.md b/getting-started/admin.md new file mode 100644 index 000000000..5948de3ee --- /dev/null +++ b/getting-started/admin.md @@ -0,0 +1,94 @@ +--- +title: Administrators +description: Getting started with Coder as an administrator. +--- + +This article will walk you through the steps needed to set up, deploy, and +configure Coder so that your developers are ready create their workspaces and +begin working on their projects. + +## Set up 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). + +Alternatively, you can leverage [Coder for Docker](../setup/docker.md), which +allows you to quickly deploy Coder to machines where you have Docker installed. +We recommend this option for teams with 5-10 developers. + +## 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) menu to set up things such as +[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC), +[create organizations](./admin/organizations/index.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](./images/writing.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/index.md) when a developer logs in +for the first time. + +## 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. + +## 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 + +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. diff --git a/getting-started/index.md b/getting-started/index.md index e0fed7f48..74406b159 100644 --- a/getting-started/index.md +++ b/getting-started/index.md @@ -11,103 +11,15 @@ icon: --- 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 publicly editable](https://github.com/cdr/docs), so -please feel free to contribute and provide feedback as you desire. - -If you're participating in our hosted beta, please see our -[guide on getting started](guides/hosted-beta/index.md). If you're deploying -Coder to your own clusters, please proceed with this article. - -## Set up 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) menu to set up things such as -[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC), -[create organizations](./admin/organizations/index.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](./images/writing.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/index.md) when a developer logs in -for the first time. - -## 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. - -## 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. +wanted to provide this onboarding guide to help you get started. + +If you've been tasked with deploying and configuring Coder, please see our +[admin](admin.md) guide for a high-level overview of what you need to do so that +your developers can create their workspaces and begin working on their projects. + +There are two primary ways of deploying Coder, and we offer developer-oriented +guides for both [Kubernetes deployments](developers.md) and +[deployments using Coder for Docker](docker.md). Once developers have a Coder +deployment available to them, these end-to-end guides will walk them through +logging in and getting set up with a sample project they can use to experience +Coder. diff --git a/manifest.json b/manifest.json index 6a449152f..e5bb79037 100644 --- a/manifest.json +++ b/manifest.json @@ -29,6 +29,9 @@ { "path": "getting-started/index.md", "children": [ + { + "path": "getting-started/admin.md" + }, { "path": "getting-started/developers.md" }, From 2c9202dafa47d02fecf1d28078199431922ee86c Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Fri, 7 Jan 2022 10:55:06 -0600 Subject: [PATCH 2/5] fix broken links --- getting-started/admin.md | 45 ++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/getting-started/admin.md b/getting-started/admin.md index 5948de3ee..af5eb9873 100644 --- a/getting-started/admin.md +++ b/getting-started/admin.md @@ -9,10 +9,10 @@ begin working on their projects. ## Set up and deploy Coder -To get started with Coder, you’ll need to [deploy Coder](./setup/index.md) to a +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). +cluster, you can [install Coder via Helm](../setup/installation.md). Alternatively, you can leverage [Coder for Docker](../setup/docker.md), which allows you to quickly deploy Coder to machines where you have Docker installed. @@ -21,37 +21,38 @@ We recommend this option for teams with 5-10 developers. ## Configure Coder After you deploy Coder, you’ll need to -[upload your license file](./setup/configuration.md) before you can configure +[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) menu to set up things such as -[access controls](./admin/access-control/index.md) with OpenID Connect (OIDC), -[create organizations](./admin/organizations/index.md), and create an OAuth app -for your users to [connect to your Git provider](./admin/git.md). +[administration management](../admin/index.md) menu to set up things such as +[access controls](../admin/access-control/index.md) with OpenID Connect (OIDC), +[create organizations](../admin/organizations/index.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](./images/writing.md) -for your developer workspaces as well. +[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](../images/writing.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 +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/index.md) when a developer logs in +[default organization](../admin/organizations/index.md) when a developer logs in for the first time. ## Automate -Coder has a [command-line (CLI) tool](./cli/index.md) that you and your +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) +welcome contributions. Additionally, Coder has a [public API](../guides/api.md) that you can use to automate various tasks through code. ## Connect local IDEs @@ -60,14 +61,14 @@ 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 +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 +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 @@ -90,5 +91,5 @@ executive if you’re interested in this option. ## Additional information 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. +[Guides](../guides/index.md) in our public documentation, as it contains more +detailed information on specific From 85c9d17d091f4e611058ddfd36aaa92a752e5923 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 10 Jan 2022 12:55:33 -0600 Subject: [PATCH 3/5] apply changes based on review --- getting-started/admin.md | 97 ++++++++++++++++++++-------------------- index.md | 2 +- 2 files changed, 50 insertions(+), 49 deletions(-) diff --git a/getting-started/admin.md b/getting-started/admin.md index af5eb9873..8ede5697b 100644 --- a/getting-started/admin.md +++ b/getting-started/admin.md @@ -9,70 +9,71 @@ begin working on their projects. ## Set up 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). +To get started with Coder, you will need to: -Alternatively, you can leverage [Coder for Docker](../setup/docker.md), which -allows you to quickly deploy Coder to machines where you have Docker installed. -We recommend this option for teams with 5-10 developers. +1. [Create a Kubernetes cluster](./setup/kubernetes/index.md) + +1. [Install Coder via Helm](../setup/installation.md) + +Alternatively, [Coder for Docker](../setup/docker.md) allows you to deploy Coder +quickly to machines where you have Docker installed. We recommend this option +for teams with 5-10 developers. ## 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) menu to set up things such as -[access controls](../admin/access-control/index.md) with OpenID Connect (OIDC), -[create organizations](../admin/organizations/index.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](../images/writing.md) for your developer workspaces as -well. +Once you've deployed Coder, you'll need to log in and: + +1. [Upload your license file](../setup/configuration.md) (you can get a trial + license for free [here](https://coder.com/trial)) + +1. Access the [administration management](../admin/index.md) menu to set up + things such as: + + - [Access controls](../admin/access-control/index.md) with OpenID Connect + (OIDC) + - [Create organizations](../admin/organizations/index.md) + - Create an OAuth app for your users to + [connect to your Git provider](../admin/git.md) + + At a minimum, you’ll want to ensure that you: + + - [Add a container registry](../admin/registries/index.md) for your + development environments to pull from + - [Import an image](../images/importing.md) with the tools your developers + need. + + You can [create custom images](../images/writing.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 +To allow developers to access your Coder deployment, you can manually create and +invite users, or you can set up OpenID Connect (OIDC): + +- [Azure AD](../guides/admin/oidc-azuread.md) +- [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/index.md) when a developer logs in for the first time. ## 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. - -## Connect local IDEs +You can use the Coder [command-line (CLI) tool](../cli/index.md) to interact +with Coder, as well as the [public API](../guides/api.md) to automate various +tasks through code. -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 upgrade -## Maintain and update +Coder releases [upgrades](../setup/upgrade/index.md) on the third Wednesday of +each month, with patch releases published and available as needed. 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. +[release calendar](https://coder.com/release-calendar.ical) to keep you updated +on features, bug fixes, security updates, and breaking changes that are coming. ## Interact with Support diff --git a/index.md b/index.md index 08b84db49..c8950dae7 100644 --- a/index.md +++ b/index.md @@ -20,7 +20,7 @@ enterprise security. Welcome to your new computer in the cloud.

- + From ba8c3243a4d889642d8276ab645ef2b791532f44 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 10 Jan 2022 14:00:20 -0600 Subject: [PATCH 4/5] fix errors --- getting-started/admin.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/getting-started/admin.md b/getting-started/admin.md index 8ede5697b..1fab5484d 100644 --- a/getting-started/admin.md +++ b/getting-started/admin.md @@ -21,28 +21,26 @@ for teams with 5-10 developers. ## Configure Coder -Once you've deployed Coder, you'll need to log in and: +Once you've deployed Coder, you'll need to log in and perform the following +configuration steps: 1. [Upload your license file](../setup/configuration.md) (you can get a trial license for free [here](https://coder.com/trial)) -1. Access the [administration management](../admin/index.md) menu to set up - things such as: +1. Set up [access controls](../admin/access-control/index.md) with OpenID + Connect (OIDC) if you'd like to allow users to register themselves - - [Access controls](../admin/access-control/index.md) with OpenID Connect - (OIDC) - - [Create organizations](../admin/organizations/index.md) - - Create an OAuth app for your users to - [connect to your Git provider](../admin/git.md) +1. [Create organizations](../admin/organizations/index.md) to manage your user + groups - At a minimum, you’ll want to ensure that you: +1. Create an OAuth app for your users to + [connect to your Git provider](../admin/git.md) - - [Add a container registry](../admin/registries/index.md) for your - development environments to pull from - - [Import an image](../images/importing.md) with the tools your developers - need. +1. [Add a container registry](../admin/registries/index.md) for your development + environments to pull from - You can [create custom images](../images/writing.md) for your developer +1. [Import an image](../images/importing.md) with the tools your developers + need. You can [create custom images](../images/writing.md) for your developer workspaces as well. ## Provision users @@ -91,6 +89,6 @@ executive if you’re interested in this option. ## Additional information -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 +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. From 4c7a670a523569c1764097713524a3e35f396257 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 10 Jan 2022 16:00:08 -0600 Subject: [PATCH 5/5] fix broken link --- getting-started/admin.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/admin.md b/getting-started/admin.md index 1fab5484d..2b29e4dd5 100644 --- a/getting-started/admin.md +++ b/getting-started/admin.md @@ -11,7 +11,7 @@ begin working on their projects. To get started with Coder, you will need to: -1. [Create a Kubernetes cluster](./setup/kubernetes/index.md) +1. [Create a Kubernetes cluster](../setup/kubernetes/index.md) 1. [Install Coder via Helm](../setup/installation.md)