- Notifications
You must be signed in to change notification settings - Fork929
docs: use about as home page#2382
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
118 changes: 95 additions & 23 deletionsdocs/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,99 @@ | ||
# About Coder | ||
Coder is an open source platform for creating and managing developer workspaces | ||
on your preferred clouds and servers. | ||
By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity. | ||
> ⚠️ Coder v2 is in **alpha** state and is not ready for production use. For | ||
> 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 | ||
is an increasingly common solution for developers[^1] and organizations[^2] | ||
alike. There are several benefits, including: | ||
- **Increased speed:** Server-grade compute speeds up operations in software | ||
development, such as IDE loading, code compilation and building, and the | ||
running of large workloads (such as those for monolith or microservice | ||
applications) | ||
- **Easier environment management:** Tools such as Terraform, nix, Docker, | ||
devcontainers, and so on make developer onboarding and the troubleshooting of | ||
development environments easier | ||
- **Increase security:** Centralize source code and other data onto private | ||
servers or cloud services instead of local developer machines | ||
- **Improved compatibility:** Remote workspaces share infrastructure | ||
configuration with other development, staging, and production environments, | ||
reducing configuration drift | ||
- **Improved accessibility:** Devices such as lightweight notebooks, | ||
Chromebooks, and iPads can connect to remote workspaces via browser-based IDEs | ||
or remote IDE extensions | ||
## Why Coder | ||
The key difference between Coder v2 and other remote IDE platforms is the added | ||
layer of infrastructure control. This additional layer allows admins to: | ||
- Support ARM, Windows, Linux, and macOS workspaces | ||
- Modify pod/container specs (e.g., adding disks, managing network policies, | ||
setting/updating environment variables) | ||
- Use VM/dedicated workspaces, developing with Kernel features (no container | ||
knowledge required) | ||
- Enable persistent workspaces, which are like local machines, but faster and | ||
hosted by a cloud service | ||
Coder includes [production-ready templates](../examples/templates) for use with AWS EC2, | ||
Azure, Google Cloud, Kubernetes, and more. | ||
## What Coder is _not_ | ||
- Coder is not an infrastructure as code (IaC) platform. Terraform is the first | ||
IaC _provisioner_ in Coder, allowing Coder admins to define Terraform | ||
resources as Coder workspaces. | ||
- Coder is not a DevOps/CI platform. Coder workspaces can follow best practices | ||
for cloud service-based workloads, but Coder is not responsible for how you | ||
define or deploy the software you write. | ||
- Coder is not an online IDE. Instead, Coder supports common editors, such as VS | ||
Code, vim, and JetBrains, over HTTPS or SSH. | ||
- Coder is not a collaboration platform. You can use git and dedicated IDE | ||
extensions for pull requests, code reviews, and pair programming. | ||
- Coder is not a SaaS/fully-managed offering. You must host | ||
Coder on a cloud service (AWS, Azure, GCP) or your private data center. | ||
Next: [Templates](./templates.md) | ||
[^1]: alexellis.io: [The Internet is my computer](https://blog.alexellis.io/the-internet-is-my-computer/) | ||
[^2]: slack.engineering: [Development environments at Slack](https://slack.engineering/development-environments-at-slack) |
99 changes: 0 additions & 99 deletionsdocs/about.md
This file was deleted.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
79 changes: 39 additions & 40 deletionsdocs/install.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
10 changes: 2 additions & 8 deletionsdocs/manifest.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.