From 3469242691ea3008901bab867f2eae101c96db4f Mon Sep 17 00:00:00 2001
From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Date: Mon, 7 Oct 2024 21:33:01 +0000
Subject: [PATCH 1/5] edits to README
---
docs/README.md | 195 ++++++++++++++++++++++++++++---------------------
1 file changed, 111 insertions(+), 84 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 8b2d3a978b487..758a4ce0d0b3f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,116 +1,143 @@
-# About Coder
+# What is Coder
-
+Coder is a self-hosted, open source, cloud development environment that works
+with any cloud, IDE, OS, Git provider, and IDP.
-Coder is an open-source platform for creating and managing developer workspaces
-on your preferred clouds and servers.
+_Screenshots of Coder workspaces and connections_
-
- 
-
+Coder is built on common development interfaces and infrastructure tools to
+make the process of provisioning and accessing remote workspaces approachable
+for organizations of various sizes and stages of cloud-native maturity.
-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.
+## IDE support
-
-
- If you are a Coder v1 customer, view the docs or the sunset plans.
-
-
+
-## How it works
+You can use:
-Coder workspaces are represented with Terraform, but no Terraform knowledge is
-required to get started. We have a
-[database](https://registry.coder.com/templates) of pre-made templates built
-into the product.
+- Any Web IDE, such as
-
- 
-
+ - [code-server](https://github.com/coder/code-server)
+ - [JetBrains Projector](https://github.com/JetBrains/projector-server)
+ - [Jupyter](https://jupyter.org/)
+ - And others
-Coder workspaces don't stop at compute. You can add storage buckets, secrets,
-sidecars and whatever else Terraform lets you dream up.
+- Your existing remote development environment:
-[Learn more about templates.](./admin/templates/index.md)
+ - [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/)
+ - [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial)
+ - [Emacs](./user-guides/workspace-access/emacs-tramp.md)
-## IDE Support
+- A file sync such as [Mutagen](https://mutagen.io/)
-You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md)
-([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
-
- 
-
+Remote development offers several benefits for users and administrators, including:
-## Why remote development
+- **Increased speed**
+
+ - Server-grade cloud hardware speeds up operations in software development, from
+ loading the IDE to compiling and building code, and running large workloads
+ such as those for monolith or microservice applications.
+
+- **Easier environment management**
+
+ - Built-in infrastructure tools such as Terraform, nix, Docker, Dev Containers, and others make it easier to onboard developers with consistent environments.
-Migrating from local developer machines to workspaces hosted by cloud services
-is an
-[increasingly common solution for developers](https://blog.alexellis.io/the-internet-is-my-computer/)
-and
-[organizations alike](https://slack.engineering/development-environments-at-slack).
-There are several benefits, including:
+- **Increased security**
-- **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)
+ - Centralize source code and other data onto private servers or cloud services instead of local developers' machines.
+ - Manage users and groups with [SSO](./admin/users/oidc-auth.md) and [Role-based access controlled (RBAC)](./admin/users/groups-roles#roles).
-- **Easier environment management:** Tools such as Terraform, nix, Docker,
- devcontainers, and so on make developer onboarding and the troubleshooting of
- development environments easier
+- **Improved compatibility**
-- **Increase security:** Centralize source code and other data onto private
- servers or cloud services instead of local developer machines
+ - Remote workspaces can share infrastructure configurations with other
+ development, staging, and production environments, reducing configuration
+ drift.
-- **Improved compatibility:** Remote workspaces share infrastructure
- configuration with other development, staging, and production environments,
- reducing configuration drift
+- **Improved accessibility**
+ - Connect to remote workspaces via browser-based IDEs or remote IDE
+ extensions to enable developers regardless of the device they use, whether
+ it's their main device, a lightweight laptop, Chromebook, or iPad.
-- **Improved accessibility:** Devices such as lightweight notebooks,
- Chromebooks, and iPads can connect to remote workspaces via browser-based IDEs
- or remote IDE extensions
+Read more about why organizations and engineers are moving to remote
+development on [our blog](https://coder.com/blog), the
+[Slack engineering blog](https://slack.engineering/development-environments-at-slack),
+or from [OpenFaaS's Alex Ellis](https://blog.alexellis.io/the-internet-is-my-computer/).
## Why Coder
-The key difference between Coder OSS and other remote IDE platforms is the added
-layer of infrastructure control. This additional layer allows admins to:
+The key difference between Coder 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)
+- Simultaneously support ARM, Windows, Linux, and macOS workspaces.
+- Modify pod/container specs, such as adding disks, managing network policies, or
+ setting/updating environment variables.
+- Use VM or 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
+ hosted by a cloud service.
+
+## How much does it cost?
+
+Coder is free and open source under
+[GNU Affero General Public License v3.0](https://github.com/coder/coder/blob/main/LICENSE).
+All developer productivity features are included in the Open Source version of
+Coder.
+A [Premium license is available](https://coder.com/pricing#compare-plans) for enhanced
+support options and custom deployments.
+
+## How does Coder work
+
+Coder workspaces are represented with Terraform, but you don't need to know
+Terraform to get started.
+We have a [database of production-ready templates](https://registry.coder.com/templates)
+for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more.
+
+_Providers and compute environments_
+
+Coder workspaces can be used for more than just compute.
+You can use Terraform to add storage buckets, secrets, sidecars,
+[and more](https://developer.hashicorp.com/terraform/tutorials).
+
+Visit the [templates documentation](./admin/templates/index.md) to learn 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 be configured to 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.
+
+ - Coder supports common editors, such as VS Code, vim, and JetBrains,
+ all over HTTPS or SSH.
-Coder includes
-[production-ready templates](https://registry.coder.com/templates) for use with
-AWS EC2, Azure, Google Cloud, Kubernetes, and more.
+- Coder is not a collaboration platform.
-## What Coder is _not_
+ - You can use Git with your favorite Git platform and dedicated IDE
+ extensions for pull requests, code reviews, and pair programming.
-- 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 SaaS/fully-managed offering.
+ - Coder is a [self-hosted]()
+ solution.
+ You must host Coder in a private data center or on a cloud service, such as
+ AWS, Azure, or GCP.
-- 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.
+## Using Coder v1?
-- Coder is not an online IDE. Instead, Coder supports common editors, such as VS
- Code, vim, and JetBrains, over HTTPS or SSH.
+If you're a Coder v1 customer, view [the v1 documentation](https://coder.com/docs/v1)
+or [the v2 migration guide and FAQ](https://coder.com/docs/v1/guides/v2-faq).
-- Coder is not a collaboration platform. You can use git and dedicated IDE
- extensions for pull requests, code reviews, and pair programming.
+## Up next
-- Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
- service (AWS, Azure, GCP) or your private data center.
+- Learn about [Templates](./admin/templates/index.md)
+- [Install Coder](./install/index.md)
From a246f124c29cb6ea5cc3d42a43f952e032a0582c Mon Sep 17 00:00:00 2001
From: Edward Angert
Date: Mon, 7 Oct 2024 17:39:47 -0400
Subject: [PATCH 2/5] Update docs/README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
😬
---
docs/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README.md b/docs/README.md
index 758a4ce0d0b3f..07ee13e2db2ab 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,4 +1,4 @@
-# What is Coder
+# About
Coder is a self-hosted, open source, cloud development environment that works
with any cloud, IDE, OS, Git provider, and IDP.
From e83c4981b45bf407547ea2e87c1e536209f6df31 Mon Sep 17 00:00:00 2001
From: Edward Angert
Date: Mon, 7 Oct 2024 17:40:27 -0400
Subject: [PATCH 3/5] warning re: H1 About
---
docs/README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/README.md b/docs/README.md
index 07ee13e2db2ab..d3120722b33c6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,5 +1,6 @@
# About
+
Coder is a self-hosted, open source, cloud development environment that works
with any cloud, IDE, OS, Git provider, and IDP.
From c9313bce034d9b3cc45718b58e8fcfab881604eb Mon Sep 17 00:00:00 2001
From: Edward Angert
Date: Mon, 7 Oct 2024 17:40:51 -0400
Subject: [PATCH 4/5] Update docs/README.md
---
docs/README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/README.md b/docs/README.md
index d3120722b33c6..59192fc694995 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,7 @@
# About
+
Coder is a self-hosted, open source, cloud development environment that works
with any cloud, IDE, OS, Git provider, and IDP.
From 57fa7aa59bef2ac551064b53bcfe21242b3a3d88 Mon Sep 17 00:00:00 2001
From: Edward Angert
Date: Thu, 10 Oct 2024 23:51:08 -0500
Subject: [PATCH 5/5] fix link
Co-authored-by: Muhammad Atif Ali
---
docs/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README.md b/docs/README.md
index 59192fc694995..71fb99d1f50b1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -49,7 +49,7 @@ Remote development offers several benefits for users and administrators, includi
- **Increased security**
- Centralize source code and other data onto private servers or cloud services instead of local developers' machines.
- - Manage users and groups with [SSO](./admin/users/oidc-auth.md) and [Role-based access controlled (RBAC)](./admin/users/groups-roles#roles).
+ - Manage users and groups with [SSO](./admin/users/oidc-auth.md) and [Role-based access controlled (RBAC)](./admin/users/groups-roles.md#roles).
- **Improved compatibility**