Skip to content

Commit 2bbfee4

Browse files
author
Katie Horne
authored
chore: fix capitalization (coder#255)
1 parent 770bed6 commit 2bbfee4

File tree

24 files changed

+63
-63
lines changed

24 files changed

+63
-63
lines changed

admin/audit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ system.
1717

1818
You can filter the logs displayed using the search filters available at the top:
1919

20-
- **Resource Type**: The resource on which the action is taken (e.g., Image,
21-
Environment, User)
20+
- **Resource Type**: The resource on which the action is taken (e.g., image,
21+
environment, user)
2222
- **Action**: The action that the user took against a resource (e.g., read,
2323
write, create)
2424
- **Resource Target**: The friendly name for the resource (e.g., the user with

admin/devurls.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ description: Learn how to configure dev URL support for a Coder deployment.
55

66
Developer (Dev) URLs allow users to access the ports of services they are
77
developing within their environment. However, before individual developers can
8-
set up Dev URLs, an administrator must configure and enable Dev URL usage.
8+
set up dev URLs, an administrator must configure and enable dev URL usage.
99

1010
## Before you proceed
1111

1212
You must own a wildcard DNS record for your custom domain name to enable and use
13-
Dev URLs with Coder.
13+
dev URLs with Coder.
1414

1515
## Enabling the use of dev URLs
1616

17-
[Dev URLs](../environments/devurls.md) is an opt-in feature. To enable Dev URLs
17+
[Dev URLs](../environments/devurls.md) is an opt-in feature. To enable dev URLs
1818
in your cluster, you'll need to modify your:
1919

2020
1. Helm chart
@@ -29,7 +29,7 @@ helm upgrade coder coder/coder --set devurls.host="*.my-custom-domain.io"
2929
```
3030

3131
If you're using the default ingress controller, specifying a value for
32-
`devurls.host` automatically adds a rule that routes Dev URL requests to the
32+
`devurls.host` automatically adds a rule that routes dev URL requests to the
3333
user's environment:
3434

3535
```yaml
@@ -47,7 +47,7 @@ rule manually.
4747
4848
### Step 2: Modify the wildcard DNS record
4949
50-
The final step to enabling Dev URLs is to update your wildcard DNS record. Get
50+
The final step to enabling dev URLs is to update your wildcard DNS record. Get
5151
the **ingress IP address** using `kubectl --namespace coder get ingress` and
5252
point your wildcard DNS record (e.g., \*.my-custom-domain.io) to the ingress IP
5353
address.

admin/environment-management/ssh-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ environment.
7474

7575
```text
7676
# --------- START CODER ENVIRONMENT VARIABLES ----------
77-
# The following has been auto-generated at Environment startup
77+
# The following has been auto-generated at environment startup
7878
# You should not hand-edit this section, unless you are deleting it.
7979
8080
SHELL=/bin/bash

admin/workspace-providers/deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ when communicating with the Coder deployment.
116116
Optionally, you can provide additional helm configuration values by providing
117117
a `values.yaml` file and adding the argument `-f my-values.yaml` to the
118118
generated command. Helm values control attributes of the workspace provider,
119-
including Dev URLs, Kubernetes storage classes, SSH, and more. See the
119+
including dev URLs, Kubernetes storage classes, SSH, and more. See the
120120
[Workspace provider Helm chart values]("https://github.com/cdr/enterprise-helm/blob/workspace-providers-envproxy-only/README.md")
121121
for more details.
122122

@@ -136,12 +136,12 @@ when communicating with the Coder deployment.
136136
provider.
137137

138138
1. Once the Helm chart has deployed successfully, you should see the workspace
139-
provider in a `ready` state on the Workspace Provider Admin page.
139+
provider in a `ready` state on the **Workspace provider admin** page.
140140

141141
![Workspace providers admin](../../assets/workspace-providers-admin.png)
142142

143-
1. From the Workspace Provider Admin page, add the desired organizations to its
144-
allowlist.
143+
1. From the **Workspace provider admin** page, add the desired organizations to
144+
its allowlist.
145145

146146
Users in the allowed organizations can now choose to deploy into the newly set
147147
up workspace provider.

admin/workspace-providers/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ page available via **Manage** > **Admin** > **Workspace Providers**.
4747
The Admin panel shows an overview of all configured workspace providers and
4848
indicates their statuses and details. The **default** tag indicates the provider
4949
that will be selected by default when a user creates an environment using the
50-
Create an Environment dialog.
50+
**Create an Environment** dialog.
5151

5252
You can expand individual listings to view in-depth information:
5353

54-
![Detailed Workspace Providers
55-
Info](../../assets/workspace-providers-detail.png)
54+
![Detailed workspace providers
55+
info](../../assets/workspace-providers-detail.png)
5656

5757
### Status
5858

changelog/1.13.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ There are no breaking changes in 1.13.2.
99

1010
### Features ✨
1111

12-
- infra: Adds support for `https` servers behind Dev URLs
12+
- infra: Adds support for `https` servers behind dev URLs
1313
- **Notice:** Environments will need to be rebuilt before using this feature
1414

1515
### Bug fixes 🐛

changelog/1.14.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ description: "Released on 12/18/2020"
1616

1717
- infra: Container-based Virtual Machines (CVMs) alpha
1818
- web: New account dormancy page in the admin panel
19-
- infra: Coder Environment variables
19+
- infra: Coder environment variables
2020
[see guide](https://coder.com/docs/environments/variables)
2121
- web: Admin panel pages have been redesigned
2222
- web: SSH information has been added to the environments page
@@ -25,7 +25,7 @@ description: "Released on 12/18/2020"
2525
active users.
2626
- web: Environment rebuild icons have been redesigned
2727
- infra: Add username label to env pod/deployment
28-
- web/projector: Progressive Web App (PWA) icons have been redesigned
28+
- web/projector: Progressive web app (PWA) icons have been redesigned
2929
- **Notice:** The Coder PWA may need to be reinstalled. An invalid cache state
3030
may occur that is fixed with a hard refresh.
3131
- infra: Git configuration build step now occurs before configure and

changelog/1.14.4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are no new features in 1.14.4.
1313

1414
### Bug fixes 🐛
1515

16-
- infra: Increase Environment rebuild timeout to 30 minutes
16+
- infra: Increase environment rebuild timeout to 30 minutes
1717
- cli: Patch panic condition in `coder config-ssh`
1818

1919
### Security updates 🔐

changelog/1.15.0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ description: "Released on 01/20/2021. Deprecated on 01/25/2021."
3434
- web: Changed how Progressive Web Apps function; the code-server application
3535
can now be installed as a PWA.
3636
- web: Added tooltip with extended information that shows when hovering over the
37-
Image info in the summary card on the `Environments` page
37+
image info in the summary card on the `Environments` page
3838
- web: Redesigned the Coder Dashboard to use NextJS and SSR. Page loads should
3939
be quicker ⚡.
4040

@@ -51,10 +51,10 @@ description: "Released on 01/20/2021. Deprecated on 01/25/2021."
5151
- jetbrains: Fixed access to the context menu from then Terminal toolbar
5252
- web: Removed display containing environment resources information if the
5353
environment isn't running
54-
- web: Updated the Import an Image dialog window to hide image tags that have
55-
already been imported
56-
- web: Updated the Create/Edit an Environment dialog; images and tags are now
57-
sorted alphabetically and then chronologically by creation date
54+
- web: Updated the **Import an Image** dialog window to hide image tags that
55+
have already been imported
56+
- web: Updated the **Create/Edit an Environment** dialog; images and tags are
57+
now sorted alphabetically and then chronologically by creation date
5858

5959
### Security updates 🔐
6060

changelog/1.16.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "Released on 02/22/2021"
99
for Services are preserved for data recovery purposes (volumes, database
1010
tables, etc.), but are not accessible through the Coder platform. Please
1111
reference [Docker in Environments](../environments/cvms) for a guide on the
12-
new workflow for running containers within your Environment.
12+
new workflow for running containers within your environment.
1313
- The built-in Internal Extension Marketplace is now **removed**. All resources
1414
created for this feature are preserved for data recovery purposes, but are not
1515
accessible through the Coder platform. For air-gapped deployments, the
@@ -31,10 +31,10 @@ description: "Released on 02/22/2021"
3131
- ex: `ssh -R 8080:localhost:8080 coder.dev`
3232
- Support for
3333
[running a full OpenSSH server](../admin/environment-management/ssh-access.md)
34-
inside your Environment.
34+
inside your environment.
3535
- The administrator configuration option "Privileged Environments" is now
3636
removed. All non-CVM environments are launched with `privileged: false`.
37-
- web: PWA icons for jetbrains and code-server have been redesigned
37+
- web: PWA icons for JetBrains and code-server have been redesigned
3838
- web: Input sliders have been redesigned
3939
- web: A character counter was added to the organization description field
4040
- web: Display warning when memory provision rate is high

changelog/1.17.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ description: "Released on 03/17/2021"
3636
**Autostart** that allows you to set a time and choose the environments that
3737
should be automatically started. We recommend enabling this feature for the
3838
environments you use the most.
39-
- web: New checkbox for opting into Autostart is available on the Create and
40-
Edit Environment modals.
39+
- web: New checkbox for opting into Autostart is available on the **Create and
40+
Edit Environment** modals.
4141
- web: Autostart action has been added to the Audit Log
4242

4343
- web: Environment stop actions have been added to the Audit Log

changelog/1.17.2.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,32 @@ There are no breaking changes in 1.17.2.
99

1010
### Features ✨
1111

12-
- Workspaces As Code (**WAC**): Workspaces as code (WAC) brings the
13-
_Infrastructure As Code_ paradigm to Coder environments. WAC allows you to
12+
- Workspaces as code (**WAC**): Workspaces as code (WAC) brings the
13+
_infrastructure as code_ paradigm to Coder environments. WAC allows you to
1414
define and create new environments using **workspace templates**.
1515
- web: New page available via **Admin** > **Templates** for creating an
1616
embeddable quickstart button.
1717
- web: New options available when clicking **New Environment** from the
1818
**Environments** page.
19-
- web: **workspace template** information is now displayed on the
19+
- web: **Workspace template** information is now displayed on the
2020
**Environments** page for environments built from a template.
2121
- web: Added _Cordon_ and _Uncordon_ actions to _Provider_ audit logs.
2222

2323
### Bug fixes 🐛
2424

25-
- infra: Fixes an issue whereby using `coder/configure` to create Dev URLs would
25+
- infra: Fixes an issue whereby using `coder/configure` to create dev URLs would
2626
fail.
27-
- infra: Fixes an issue authenticating using OpenID Connect Identity Providers
27+
- infra: Fixes an issue authenticating using OpenID Connect identity providers
2828
(IdPs) that omit name information, such as GitLab. In this case, Coder will
2929
use the email address as the user's name.
3030
- infra: Improved validation for environment names. Previously, a long
3131
environment name may have caused build errors.
32-
- web: The Dev URLs card on the **Environments** page now refreshes after an
32+
- web: The dev URLs card on the **Environments** page now refreshes after an
3333
environment finishes building.
34-
- jetbrains: Fixed an issue whereby Jetbrains IDE processes would start and
35-
always run. They now start on request when opening Jetbrains IDEs.
34+
- jetbrains: Fixed an issue whereby JetBrains IDE processes would start and
35+
always run. They now start on request when opening JetBrains IDEs.
3636
- web: Improved reliability of the workspace provider ping indicator.
37-
- web: Fixed incorrect timestamps in an image's _Available Tags_ table.
37+
- web: Fixed incorrect timestamps in an image's **Available Tags** table.
3838

3939
### Security updates 🔐
4040

cli/file-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ help ensure your project is in the same state no matter where you make changes.
5757
$ ssh coder.yourName
5858
```
5959

60-
1. Identify your project directory and Environment name, then create the sync
60+
1. Identify your project directory and environment name, then create the sync
6161
session. Note that the folder must exist on the remote server before you
6262
begin this step:
6363

cli/remote-terminal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Remote terminal"
33
description: Learn how to use the Coder CLI to access your environment.
44
---
55

6-
You can access the the shell of your Coder Environment from your local computer
6+
You can access the the shell of your Coder environment from your local computer
77
using the CLI's `coder sh` command.
88

99
## Usage
@@ -13,7 +13,7 @@ coder sh <env name> [<command [args...]>]
1313
```
1414

1515
This executes a remote command on the environment; if no command is specified,
16-
the CLI opens up the Environment's default shell.
16+
the CLI opens up the environment's default shell.
1717

1818
For example, you can print "Hello World" in your Coder environment shell as
1919
follows:

environments/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ existing environments. Click the **New Environment** button.
2424
1. Click **Create** to proceed.
2525

2626
Coder redirects you to an overview page for your environment during the build
27-
process. Learn more about the Environment
27+
process. Learn more about the environment
2828
[creation parameters](./environment-params.md).
2929

3030
Your environment persists in the home directory, updates to new versions of the

environments/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ description: "Learn about development environments in Coder."
2121
---
2222

2323
An environment is your remote development workspace. All environment are based
24-
on a shared [Image](../images/index.md) and therefore reproducible.
24+
on a shared [image](../images/index.md) and therefore reproducible.
2525

2626
![Environments](../assets/environments.svg)
2727

environments/preferences.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The **Account** tab allows you to provide or change:
1414
- Your display name
1515
- Email address
1616
- Username (this is the value that Coder uses throughout the platform, including
17-
in Dev URLs and the CLI's SSH configuration)
17+
in dev URLs and the CLI's SSH configuration)
1818
- Your dotfiles URI to personalize your environments
1919
- Your avatar
2020

guides/customization/custom-env.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ To demonstrate, we'll create a development image that utilizes
4747

4848
We have a copy of this image
4949
[built and pushed](https://hub.docker.com/r/coderenterprise/react) to our Docker
50-
Hub repository. You can use this and skip to **Step 3: Create the Dev
51-
Environment** if you don't want to build and push your own image.
50+
Hub repository. You can use this and skip to **Step 3: Create the dev
51+
environment** if you don't want to build and push your own image.
5252

5353
However, if you want to see how the image is made, please continue with the
5454
following section.
@@ -201,8 +201,8 @@ Once you've started your server, you can preview your application using the web
201201
browser of your choice (you must have [dev URLs](../../admin/devurls.md) enabled
202202
for this to work). To do so:
203203

204-
1. On the Environment Overview of your Coder deployment, go to Dev URLs and
205-
click **Add URL**.
204+
1. On the **Environment Overview** of your Coder deployment, go to **Dev URLs**
205+
and click **Add URL**.
206206
1. In **Port**, enter **3000**.
207207
1. Click **Save**.
208208
1. Use the generated URL in a web browser to see your application.
@@ -211,9 +211,9 @@ for this to work). To do so:
211211

212212
At this point, you can open the IDE to start working on your project.
213213

214-
On the Environment Overview, click Open Editor. Choose the editor you'd like to
215-
work in (Coder will open this in a new tab). Once the editor window opens, you
216-
can navigate to your **coder-app** directory and begin working.
214+
On the **Environment Overview**, click Open Editor. Choose the editor you'd like
215+
to work in (Coder will open this in a new tab). Once the editor window opens,
216+
you can navigate to your **coder-app** directory and begin working.
217217

218218
You can see the changes you're making in the web browser whose URL points to
219219
your application.

guides/deployments/code-server.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Kubernetes, you may want to consider Coder, our solution for developers and
99
development teams. Coder runs on Kubernetes and offers the following features in
1010
addition to the base code-server functionality.
1111

12-
## Environment Consistency
12+
## Environment consistency
1313

1414
- [Manage and distribute workspace images](https://coder.com/docs/images)
1515
- [Build custom workspaces that include your project's dependencies](https://coder.com/docs/images/structure)
1616

1717
![Coder Dashboard](../../assets/jetbrains-launcher-icons.png)
1818

19-
## Developer Workflows
19+
## Developer workflows
2020

2121
- [Connect to workspaces via web: (code-server, JetBrains)](https://coder.com/docs/environments/editors#jetbrains-ides-in-the-browser)
2222
- [Connect to workspaces via SSH or VS Code Remote](https://coder.com/docs/environments/ssh)
@@ -28,7 +28,7 @@ addition to the base code-server functionality.
2828

2929
![User management icon](../../assets/manage-users.png)
3030

31-
## Team Management
31+
## Team management
3232

3333
- [Implement single-sign-on](https://coder.com/docs/admin/access-control#openid-connect)
3434
- [Assign user roles](https://coder.com/docs/admin/access-control/user-roles)
@@ -43,7 +43,7 @@ addition to the base code-server functionality.
4343

4444
<hr />
4545

46-
## Getting Started
46+
## Getting started
4747

4848
Coder is free to try for 60 days. See our
4949
[install guide](https://coder.com/docs/setup) for additional details.

guides/ssl-certificates/cloudflare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ cert-manager supports HTTP01 and DNS01 challenges, as well as
5959
[many DNS providers](https://cert-manager.io/docs/configuration/acme/dns01/#supported-dns01-providers).
6060
This guide, however, shows you how to use Cloudflare for DNS01 challenges. This
6161
is necessary to issue wildcard certificates, which are required for Coder's
62-
[Dev URLs](../../admin/devurls.md) feature.
62+
[dev URLs](../../admin/devurls.md) feature.
6363

6464
First, get the Cloudflare API credentials for cert-manager to use; cert-manager
6565
needs permission to add a temporary TXT record and delete it after the challenge

guides/ssl-certificates/route53.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ authority.
1313
This guide will show you how to install cert-manager v1.0.1 and set up your
1414
cluster to issue Let's Encrypt certificates for your Coder installation so that
1515
you can enable HTTPS on your Coder deployment. It will also show you how to
16-
configure your Coder hostname and Dev URLs.
16+
configure your Coder hostname and dev URLs.
1717

1818
> We recommend reviewing the official cert-manager
1919
> [documentation](https://cert-manager.io/docs/) if you encounter any issues or
@@ -61,7 +61,7 @@ You should also:
6161

6262
## Step 2: Delegate your domain names and set up DNS01 challenges
6363

64-
Because Coder dynamically generates domains (specifically the Dev URLs), your
64+
Because Coder dynamically generates domains (specifically the dev URLs), your
6565
certificates need to be approved and challenged. The follow steps will show you
6666
how to use Route 53 for DNS01 challenges.
6767

@@ -165,7 +165,7 @@ URLs work.
165165
1. Create a new record for your hostname; provide `coder` as the record name and
166166
paste the external IP as the `value`. Save.
167167

168-
1. Create another record for your Dev URLs: set it to `*.dev.exampleCo` or
168+
1. Create another record for your dev URLs: set it to `*.dev.exampleCo` or
169169
similar and use the same external IP as the previous step for `value`. Save.
170170

171171
At this point, you can return to **step 6** of the

0 commit comments

Comments
 (0)