From 0b6a1776751a11da08c1ec39b9840a7b32b70b43 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 7 Jun 2022 20:38:59 +0000 Subject: [PATCH 1/6] docs: move docs table of contents to docs/index.md --- README.md | 22 ++++------------------ docs/index.md | 20 ++++++++++++++++++++ 2 files changed, 24 insertions(+), 18 deletions(-) create mode 100644 docs/index.md diff --git a/README.md b/README.md index c1b0dedc92d53..ec25affb409f0 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,12 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder) -## Run Coder *now* +## Run Coder _now_ -```curl -L https://coder.com/install.sh | sh``` +`curl -L https://coder.com/install.sh | sh` ## What Coder does + Coder creates remote development machines so you can develop your code from anywhere. #coder > **Note**: @@ -119,22 +120,7 @@ coder templates update gcp-linux ## Documentation -- [About Coder](./docs/about.md#about-coder) - - [Why remote development](./docs/about.md#why-remote-development) - - [Why Coder](./docs/about.md#why-coder) - - [What Coder is not](./docs/about.md#what-coder-is-not) - - [Comparison: Coder vs. [product]](./docs/about.md#comparison) -- [Templates](./docs/templates.md) - - [Manage templates](./docs/templates.md#manage-templates) - - [Persistent and ephemeral - resources](./docs/templates.md#persistent-and-ephemeral-resources) - - [Parameters](./docs/templates.md#parameters) -- [Workspaces](./docs/workspaces.md) - - [Create workspaces](./docs/workspaces.md#create-workspaces) - - [Connect with SSH](./docs/workspaces.md#connect-with-ssh) - - [Editors and IDEs](./docs/workspaces.md#editors-and-ides) - - [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle) - - [Updating workspaces](./docs/workspaces.md#updating-workspaces) +Visit our docs [here](./docs/index.md). ## Community diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000000..e7ebc09ff9a81 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +# Coder Documentation + +## Table of Contents + +- [About Coder](./about.md#about-coder) + - [Why remote development](./about.md#why-remote-development) + - [Why Coder](./about.md#why-coder) + - [What Coder is not](./about.md#what-coder-is-not) + - [Comparison: Coder vs. [product]](./about.md#comparison) +- [Templates](./templates.md) + - [Manage templates](./templates.md#manage-templates) + - [Persistent and ephemeral + resources](./templates.md#persistent-and-ephemeral-resources) + - [Parameters](./templates.md#parameters) +- [Workspaces](./workspaces.md) + - [Create workspaces](./workspaces.md#create-workspaces) + - [Connect with SSH](./workspaces.md#connect-with-ssh) + - [Editors and IDEs](./workspaces.md#editors-and-ides) + - [Workspace lifecycle](./workspaces.md#workspace-lifecycle) + - [Updating workspaces](./workspaces.md#updating-workspaces) From 2d942c56f818e316e22dc1217d8810b98cb3cf9c Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 7 Jun 2022 20:42:23 +0000 Subject: [PATCH 2/6] docs: move how it works and IDE support to about.md --- README.md | 22 ---------------------- docs/about.md | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index ec25affb409f0..2ca69ac45c7b0 100644 --- a/README.md +++ b/README.md @@ -37,28 +37,6 @@ Coder creates remote development machines so you can develop your code from anyw - Automatically shut down expensive cloud resources - Keep your source code and data behind your firewall -## How it works - -Coder workspaces are represented with Terraform. But, no Terraform knowledge is -required to get started. We have a database of pre-made templates built into the -product. - -

- -

- -Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars -and whatever else Terraform lets you dream up. - -[Learn more about managing infrastructure.](./docs/templates.md) - -## IDE Support - -You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/). - -

- -

## Installing Coder diff --git a/docs/about.md b/docs/about.md index 9b0b29961fb26..3593d5b32252b 100644 --- a/docs/about.md +++ b/docs/about.md @@ -9,6 +9,29 @@ By building on top of common development interfaces (SSH) and infrastructure too > production environments, please consider [Coder v1](https://coder.com/docs) or > [code-server](https://github.com/cdr/code-server). +## How it works + +Coder workspaces are represented with Terraform. But, no Terraform knowledge is +required to get started. We have a database of pre-made templates built into the +product. + +

+ +

+ +Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars +and whatever else Terraform lets you dream up. + +[Learn more about managing infrastructure.](./templates.md) + +## IDE Support + +You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/). + +

+ +

+ ## Why remote development Migrating from local developer machines to workspaces hosted by cloud services From ecc83dd5f333dffbb5efb93cde3bdbc53941f02e Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 7 Jun 2022 20:49:56 +0000 Subject: [PATCH 3/6] docs: move readme steps to walkthrough --- README.md | 49 +++++++-------------------------------------- docs/walkthrough.md | 37 ++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 42 deletions(-) create mode 100644 docs/walkthrough.md diff --git a/README.md b/README.md index 2ca69ac45c7b0..884b23abddd8f 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,6 @@ Coder creates remote development machines so you can develop your code from anyw - Automatically shut down expensive cloud resources - Keep your source code and data behind your firewall - ## Installing Coder There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux). @@ -62,50 +61,10 @@ coder server --dev Use `coder --help` to get a complete list of flags and environment variables. -## Creating your first template and workspace - -In a new terminal window, run the following to copy a sample template: - -```bash -coder templates init -``` - -Follow the CLI instructions to modify and create the template specific for your -usage (e.g., a template to **Develop in Linux on Google Cloud**). - -Create a workspace using your template: - -```bash -coder create --template="yourTemplate" -``` - -Connect to your workspace via SSH: - -```bash -coder ssh -``` - -## Modifying templates - -You can edit the Terraform template using a sample template: - -```sh -coder templates init -cd gcp-linux/ -vim main.tf -coder templates update gcp-linux -``` - ## Documentation Visit our docs [here](./docs/index.md). -## Community - -Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder! - -[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) - ## Comparison Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not). @@ -119,7 +78,13 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa --- -_As of 5/27/22_ +_Last updated: 5/27/22_ + +## Community + +Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder! + +[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) ## Contributing diff --git a/docs/walkthrough.md b/docs/walkthrough.md new file mode 100644 index 0000000000000..efeb212fba39d --- /dev/null +++ b/docs/walkthrough.md @@ -0,0 +1,37 @@ +# Walkthrough + +This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md). + +## Creating your first template and workspace + +In a new terminal window, run the following to copy a sample template: + +```bash +coder templates init +``` + +Follow the CLI instructions to modify and create the template specific for your +usage (e.g., a template to **Develop in Linux on Google Cloud**). + +Create a workspace using your template: + +```bash +coder create --template="yourTemplate" +``` + +Connect to your workspace via SSH: + +```bash +coder ssh +``` + +## Modifying templates + +If needed, you can edit the Terraform template using a sample template: + +```sh +coder templates init +cd gcp-linux/ +vim main.tf +coder templates update gcp-linux +``` From 0f8f45e486cb6fd6860e61b18cffed024501f517 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 7 Jun 2022 22:23:35 +0000 Subject: [PATCH 4/6] docs: slim down readme --- README.md | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 884b23abddd8f..ee6284ac1b911 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,19 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder) -## Run Coder _now_ - -`curl -L https://coder.com/install.sh | sh` - -## What Coder does - -Coder creates remote development machines so you can develop your code from anywhere. #coder - -> **Note**: -> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose). +Coder creates remote development machines so your team can develop from anywhere.

+**Manage less** + +- Ensure your entire team is using the same tools and resources + - Rollout critical updates to your developers with one command +- Automatically shut down expensive cloud resources +- Keep your source code and data behind your firewall + **Code more** - Build and test faster @@ -30,14 +28,10 @@ Coder creates remote development machines so you can develop your code from anyw - Access your environment from any place on any client (even an iPad) - Onboard instantly then stay up to date continuously -**Manage less** +## Getting Started -- Ensure your entire team is using the same tools and resources - - Rollout critical updates to your developers with one command -- Automatically shut down expensive cloud resources -- Keep your source code and data behind your firewall - -## Installing Coder +> **Note**: +> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new). There are a few ways to install Coder: [install script](./docs/install.md#installsh) (macOS, Linux), [docker-compose](./docs/install.md#docker-compose), or [manually](./docs/install.md#manual) via the latest release (macOS, Windows, and Linux). @@ -59,7 +53,7 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m coder server --dev ``` -Use `coder --help` to get a complete list of flags and environment variables. +Use `coder --help` to get a complete list of flags and environment variables. For a full walkthrough, follow [this guide](./docs/walkthrough.md). ## Documentation @@ -82,7 +76,7 @@ _Last updated: 5/27/22_ ## Community -Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder! +Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)! [Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose) From 9238232ed3f184b667ccf7db4d5bd12568612a7f Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 8 Jun 2022 15:13:23 +0000 Subject: [PATCH 5/6] refactor: walkthrough -> quickstart --- README.md | 2 +- docs/index.md | 3 +++ docs/{walkthrough.md => quickstart.md} | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) rename docs/{walkthrough.md => quickstart.md} (98%) diff --git a/README.md b/README.md index ee6284ac1b911..1275bdc36e227 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m coder server --dev ``` -Use `coder --help` to get a complete list of flags and environment variables. For a full walkthrough, follow [this guide](./docs/walkthrough.md). +Use `coder --help` to get a complete list of flags and environment variables follow our [quickstart guide](./docs/quickstart.md). ## Documentation diff --git a/docs/index.md b/docs/index.md index e7ebc09ff9a81..e01b58e5fa0d8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,9 @@ - [Why Coder](./about.md#why-coder) - [What Coder is not](./about.md#what-coder-is-not) - [Comparison: Coder vs. [product]](./about.md#comparison) +- [Quickstart](./quickstart.md) + - [Creating your first template and workspace](./quickstart.md#creating-your-first-template-and-workspace) + - [Modifying templates](./quickstart.md#modifying-templates) - [Templates](./templates.md) - [Manage templates](./templates.md#manage-templates) - [Persistent and ephemeral diff --git a/docs/walkthrough.md b/docs/quickstart.md similarity index 98% rename from docs/walkthrough.md rename to docs/quickstart.md index efeb212fba39d..0b069f4319a4f 100644 --- a/docs/walkthrough.md +++ b/docs/quickstart.md @@ -1,4 +1,4 @@ -# Walkthrough +# Quickstart This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md). From 5c40887cfe872d8e1f0f40fb580714eb630e25ca Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 8 Jun 2022 15:15:15 +0000 Subject: [PATCH 6/6] docs: minor edits --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1275bdc36e227..30f11fa570ffc 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Once installed, you can run a temporary deployment in dev mode (all data is in-m coder server --dev ``` -Use `coder --help` to get a complete list of flags and environment variables follow our [quickstart guide](./docs/quickstart.md). +Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](./docs/quickstart.md) for a full walkthrough. ## Documentation @@ -74,7 +74,7 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa _Last updated: 5/27/22_ -## Community +## Community and Support Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!