fix grammar and comments from feedback

coder · kylecarbs · Mar 31, 2022 · Mar 30, 2022 · Mar 30, 2022 · Mar 30, 2022
commit 43b5b2e2d61e73554c00c8b680fed7006e659ffe
diff --git a/examples/README.md b/examples/README.md
@@ -1,35 +1,19 @@
-# Project examples
+# Examples
 
-| Project name                 | OS, Type                      | Features                                                | Status  |
-| ---------------------------- | ----------------------------- | ------------------------------------------------------- | ------- |
-| [gcp-windows](./gcp-windows) | VM, Windows Server 2022       | Regions, instance type                                  | Basic   |
-| [gcp-linux](./gcp-linux)     | VM, Ubuntu 20.04              | Regions, instance type                                  | Basic   |
-| [aws-linux](./aws-linux)     | VM, Ubuntu 20.04              | Regions, instance type                                  | Basic   |
-| [aws-windows](./aws-windows) | VM, Windows Server 2019       | Regions, instance type                                  | Basic   |
-| [aws-macos](./aws-macos)     | Mac Mini, OSX 12 Monterey     | Regions, instance type                                  | WIP     |
-| kubernetes                   | Container/pod spec, any linux | Custom image, registry, provisioning ratio, PVC support | Planned |
+Examples are available in our CLI with `coder projects init`
 
-## How to use
+> Submit [an issue](https://github.com/coder/coder/issues/new) if you experience issues with an example!
 
-These are embedded as examples when you run `coder projects init`. Optionally modify the terraform and use `coder projects create` or `coder projects update`, if you have already imported the project.
+## Getting Sarted
 
-You can still use projects that are not embedded in your version of Coder:
+Manually clone to create a project from any example in this repo:
 
 ```sh
 git clone https://github.com/coder/coder
 cd examples/aws-macos
 coder projects create
 ```
 
-## Statuses
-
-- Planned
-- WIP
-- Basic (proof of concept)
-- Beta
-- Stable
-- Broken/unsupported
-
 ## Requests
 
 Submit [an issue](https://github.com/coder/coder/issues/new) or pull request to request features or more examples.
diff --git a/examples/aws-linux/README.md b/examples/aws-linux/README.md
@@ -1,14 +1,5 @@
 ---
 name: Develop in Linux on AWS
-description: Get started with Linux development on AWS (EC2).
+description: Get started with Linux development on AWS.
 tags: [cloud, aws]
 ---
-
-## Supported features
-
-- Persistent storage
-- Start/stop
-
-## User preferences
-
-- Region
diff --git a/examples/aws-linux/main.tf b/examples/aws-linux/main.tf
@@ -86,8 +86,7 @@ resource "coder_agent" "dev" {
 
 locals {
 
-  # with AWS, we are using user data
-  # to start/stop instances with Terraform
+  # User data is used to stop/start AWS instances. See:
   # https://github.com/hashicorp/terraform-provider-aws/issues/22
 
   user_data_start = <<EOT

diff --git a/examples/aws-windows/README.md b/examples/aws-windows/README.md
@@ -1,14 +1,5 @@
 ---
 name: Develop in Windows on AWS
-description: Get started with Windows development on AWS (EC2).
+description: Get started with Windows development on AWS.
 tags: [cloud, aws]
 ---
-
-## Supported features
-
-- Persistent storage
-- Start/stop
-
-## User preferences
-
-- Region
diff --git a/examples/aws-windows/main.tf b/examples/aws-windows/main.tf
@@ -70,8 +70,7 @@ resource "coder_agent" "dev" {
 
 locals {
 
-  # with AWS, we are using user data
-  # to start/stop instances with Terraform
+  # User data is used to stop/start AWS instances. See:
   # https://github.com/hashicorp/terraform-provider-aws/issues/22
 
   user_data_start = <<EOT
@@ -91,7 +90,6 @@ EOT
 }
 
 resource "aws_instance" "dev" {
-  # count             = data.coder_workspace.me.transition == "start" ? 1 : 0
   ami               = data.aws_ami.windows.id
   availability_zone = "${var.region}a"
   instance_type     = "t3.micro"