docs: slim down readme (#2140)

* docs: move docs table of contents to docs/index.md

* docs: move how it works and IDE support to about.md

* docs: move readme steps to walkthrough

* docs: slim down readme

* refactor: walkthrough -> quickstart

* docs: minor edits
This commit is contained in:
Joe Previte
2022-06-08 08:37:03 -07:00
committed by GitHub
parent 8cfe223192
commit b6899e2c18
4 changed files with 101 additions and 95 deletions
+23
View File
@@ -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.
<p align="center">
<img src="./images/providers-compute.png">
</p>
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/).
<p align="center">
<img src="./images/ide-icons.svg" height=72>
</p>
## Why remote development
Migrating from local developer machines to workspaces hosted by cloud services
+23
View File
@@ -0,0 +1,23 @@
# 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)
- [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
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)
+37
View File
@@ -0,0 +1,37 @@
# 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).
## 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" <workspaceName>
```
Connect to your workspace via SSH:
```bash
coder ssh <workspaceName>
```
## 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
```