Skip to content

docs: slim down readme #2140

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.

Sign up for GitHub

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 6 commits into from
Jun 8, 2022
Merged

docs: slim down readme #2140

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0b6a177
docs: move docs table of contents to docs/index.md
jsjoeio Jun 7, 2022
2d942c5
docs: move how it works and IDE support to about.md
jsjoeio Jun 7, 2022
ecc83dd
docs: move readme steps to walkthrough
jsjoeio Jun 7, 2022
0f8f45e
docs: slim down readme
jsjoeio Jun 7, 2022
9238232
refactor: walkthrough -> quickstart
jsjoeio Jun 8, 2022
5c40887
docs: minor edits
jsjoeio Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: move readme steps to walkthrough
  • Loading branch information
@jsjoeio
jsjoeio committed Jun 7, 2022
commit ecc83dd5f333dffbb5efb93cde3bdbc53941f02e
49 changes: 7 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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" <workspaceName>
```

Connect to your workspace via SSH:

```bash
coder ssh <workspaceName>
```

## 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).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I called it index.md because that was what first came to mind. Open to other suggestions.


## 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).
Expand All @@ -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_
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Felt like this was easier to understand


## 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

Expand Down
37 changes: 37 additions & 0 deletions docs/walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" <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
```