Skip to content

Commit c875319

Browse files
author
Katie Horne
committed
Merge branch 'bpmct/docs' of https://github.com/coder/coder into bpmct/docs
2 parents 2ef477d + 75af45b commit c875319

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

docs/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Provision remote development environments with Terraform.
1818

1919
## Installing Coder
2020

21-
Install [the latest release](https://github.com/coder/coder/releases) on a
22-
system with at least 2 CPU cores and 2 GB RAM.
21+
Install [the latest release](https://github.com/coder/coder/releases) on a system with
22+
at least 1 CPU core and 2 GB RAM.
2323

2424
To test, start with dev mode (all data is in-memory and is destroyed on exit):
2525

@@ -95,4 +95,3 @@ coder templates update gcp-linux
9595
## Contributing
9696

9797
Read the [contributing docs](./CONTRIBUTING.md).
98-

docs/about.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Azure, Google Cloud, Kubernetes, and more.
5252

5353
## What Coder is *not*
5454

55-
- Coder is an infrastructure-as-code (IaC) platform. Terraform is the first IaC
56-
*provisioner* in Coder. As a result, Coder admins can define Terraform
57-
resources as Coder workspaces.
55+
- Coder is not an infrastructure as code (IaC) platform. Terraform is the first
56+
IaC *provisioner* in Coder, allowing Coder admins to define Terraform
57+
resources as Coder workspaces.
5858

5959
- Coder is not a DevOps/CI platform. Coder workspaces can follow best practices
6060
for cloud service-based workloads, but Coder is not responsible for how you

docs/templates.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@ template:
3939
| └─ nodejs (linux, amd64) | |
4040
| api_token.backend | ephemeral |
4141

42-
When a workspace is deleted, all related resources are destroyed.
42+
When a workspace is deleted, all resources are destroyed.
4343

44-
## Variables
44+
## Parameters
4545

46-
Templates often contain *variables*. In Coder, there are two types of variables:
46+
Templates often contain *parameters*. In Coder, there are two types of parameters:
4747

48-
- **Admin variables** are set when a template is created/updated. These values
48+
- **Admin parameters** are set when a template is created/updated. These values
4949
are often cloud secrets, such as a `ServiceAccount` token, and are annotated
5050
with `sensitive = true` in the template code.
5151

52-
**User variables** are set when a user creates a workspace. They are unique to
52+
**User parameters** are set when a user creates a workspace. They are unique to
5353
each workspace, and they are often personalization settings such as preferred
5454
region or workspace image.
5555

0 commit comments

Comments
 (0)