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
+101 −95
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 how it works and IDE support to about.md
  • Loading branch information
@jsjoeio
jsjoeio committed Jun 7, 2022
commit 2d942c56f818e316e22dc1217d8810b98cb3cf9c
22 changes: 0 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Diff is hard to read. I just moved these down a bit.


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="./docs/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.](./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/).

<p align="center">
<img src="./docs/images/ide-icons.svg" height=72>
</p>
Comment on lines -58 to -60
Copy link
Member

Choose a reason for hiding this comment

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

While it does take up some scrolling space, we've received some early feedback that the IDE/cloud icons helped explain what Coder does. Do you think these make the README more confusing?

Copy link
Member

@bpmct bpmct Jun 8, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

hmm... When we use a product screenshot, we can attempt to include the use of the IDE icons and clouds there

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 like the second idea!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we've received some early feedback that the IDE/cloud icons helped explain what Coder does

I agree with this, but it also makes me wonder, does our copy not convey this already? It probably should! aka the IDE/Cloud icons should be additive and shouldn't be necessary to explain Coder.


## Installing Coder

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