Skip to content

chore: fix capitalization #255

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions admin/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ system.

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

- **Resource Type**: The resource on which the action is taken (e.g., Image,
Environment, User)
- **Resource Type**: The resource on which the action is taken (e.g., image,
environment, user)
- **Action**: The action that the user took against a resource (e.g., read,
write, create)
- **Resource Target**: The friendly name for the resource (e.g., the user with
Expand Down
10 changes: 5 additions & 5 deletions admin/devurls.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ description: Learn how to configure dev URL support for a Coder deployment.

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

## Before you proceed

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

## Enabling the use of dev URLs

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

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

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

```yaml
Expand All @@ -47,7 +47,7 @@ rule manually.

### Step 2: Modify the wildcard DNS record

The final step to enabling Dev URLs is to update your wildcard DNS record. Get
The final step to enabling dev URLs is to update your wildcard DNS record. Get
the **ingress IP address** using `kubectl --namespace coder get ingress` and
point your wildcard DNS record (e.g., \*.my-custom-domain.io) to the ingress IP
address.
2 changes: 1 addition & 1 deletion admin/environment-management/ssh-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ environment.

```text
# --------- START CODER ENVIRONMENT VARIABLES ----------
# The following has been auto-generated at Environment startup
# The following has been auto-generated at environment startup
# You should not hand-edit this section, unless you are deleting it.

SHELL=/bin/bash
Expand Down
8 changes: 4 additions & 4 deletions admin/workspace-providers/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ when communicating with the Coder deployment.
Optionally, you can provide additional helm configuration values by providing
a `values.yaml` file and adding the argument `-f my-values.yaml` to the
generated command. Helm values control attributes of the workspace provider,
including Dev URLs, Kubernetes storage classes, SSH, and more. See the
including dev URLs, Kubernetes storage classes, SSH, and more. See the
[Workspace provider Helm chart values]("https://github.com/cdr/enterprise-helm/blob/workspace-providers-envproxy-only/README.md")
for more details.

Expand All @@ -136,12 +136,12 @@ when communicating with the Coder deployment.
provider.

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

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

1. From the Workspace Provider Admin page, add the desired organizations to its
allowlist.
1. From the **Workspace provider admin** page, add the desired organizations to
its allowlist.

Users in the allowed organizations can now choose to deploy into the newly set
up workspace provider.
Expand Down
6 changes: 3 additions & 3 deletions admin/workspace-providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ page available via **Manage** > **Admin** > **Workspace Providers**.
The Admin panel shows an overview of all configured workspace providers and
indicates their statuses and details. The **default** tag indicates the provider
that will be selected by default when a user creates an environment using the
Create an Environment dialog.
**Create an Environment** dialog.

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

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

### Status

Expand Down
2 changes: 1 addition & 1 deletion changelog/1.13.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There are no breaking changes in 1.13.2.

### Features ✨

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

### Bug fixes 🐛
Expand Down
4 changes: 2 additions & 2 deletions changelog/1.14.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: "Released on 12/18/2020"

- infra: Container-based Virtual Machines (CVMs) alpha
- web: New account dormancy page in the admin panel
- infra: Coder Environment variables
- infra: Coder environment variables
[see guide](https://coder.com/docs/environments/variables)
- web: Admin panel pages have been redesigned
- web: SSH information has been added to the environments page
Expand All @@ -25,7 +25,7 @@ description: "Released on 12/18/2020"
active users.
- web: Environment rebuild icons have been redesigned
- infra: Add username label to env pod/deployment
- web/projector: Progressive Web App (PWA) icons have been redesigned
- web/projector: Progressive web app (PWA) icons have been redesigned
- **Notice:** The Coder PWA may need to be reinstalled. An invalid cache state
may occur that is fixed with a hard refresh.
- infra: Git configuration build step now occurs before configure and
Expand Down
2 changes: 1 addition & 1 deletion changelog/1.14.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are no new features in 1.14.4.

### Bug fixes 🐛

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

### Security updates 🔐
Expand Down
10 changes: 5 additions & 5 deletions changelog/1.15.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "Released on 01/20/2021. Deprecated on 01/25/2021."
- web: Changed how Progressive Web Apps function; the code-server application
can now be installed as a PWA.
- web: Added tooltip with extended information that shows when hovering over the
Image info in the summary card on the `Environments` page
image info in the summary card on the `Environments` page
- web: Redesigned the Coder Dashboard to use NextJS and SSR. Page loads should
be quicker ⚡.

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

### Security updates 🔐

Expand Down
6 changes: 3 additions & 3 deletions changelog/1.16.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "Released on 02/22/2021"
for Services are preserved for data recovery purposes (volumes, database
tables, etc.), but are not accessible through the Coder platform. Please
reference [Docker in Environments](../environments/cvms) for a guide on the
new workflow for running containers within your Environment.
new workflow for running containers within your environment.
- The built-in Internal Extension Marketplace is now **removed**. All resources
created for this feature are preserved for data recovery purposes, but are not
accessible through the Coder platform. For air-gapped deployments, the
Expand All @@ -31,10 +31,10 @@ description: "Released on 02/22/2021"
- ex: `ssh -R 8080:localhost:8080 coder.dev`
- Support for
[running a full OpenSSH server](../admin/environment-management/ssh-access.md)
inside your Environment.
inside your environment.
- The administrator configuration option "Privileged Environments" is now
removed. All non-CVM environments are launched with `privileged: false`.
- web: PWA icons for jetbrains and code-server have been redesigned
- web: PWA icons for JetBrains and code-server have been redesigned
- web: Input sliders have been redesigned
- web: A character counter was added to the organization description field
- web: Display warning when memory provision rate is high
Expand Down
4 changes: 2 additions & 2 deletions changelog/1.17.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ description: "Released on 03/17/2021"
**Autostart** that allows you to set a time and choose the environments that
should be automatically started. We recommend enabling this feature for the
environments you use the most.
- web: New checkbox for opting into Autostart is available on the Create and
Edit Environment modals.
- web: New checkbox for opting into Autostart is available on the **Create and
Edit Environment** modals.
- web: Autostart action has been added to the Audit Log

- web: Environment stop actions have been added to the Audit Log
Expand Down
18 changes: 9 additions & 9 deletions changelog/1.17.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,32 @@ There are no breaking changes in 1.17.2.

### Features ✨

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

### Bug fixes 🐛

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

### Security updates 🔐

Expand Down
2 changes: 1 addition & 1 deletion cli/file-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ help ensure your project is in the same state no matter where you make changes.
$ ssh coder.yourName
```

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

Expand Down
4 changes: 2 additions & 2 deletions cli/remote-terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Remote terminal"
description: Learn how to use the Coder CLI to access your environment.
---

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

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

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

For example, you can print "Hello World" in your Coder environment shell as
follows:
Expand Down
2 changes: 1 addition & 1 deletion environments/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ existing environments. Click the **New Environment** button.
1. Click **Create** to proceed.

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

Your environment persists in the home directory, updates to new versions of the
Expand Down
2 changes: 1 addition & 1 deletion environments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: "Learn about development environments in Coder."
---

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

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

Expand Down
2 changes: 1 addition & 1 deletion environments/preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The **Account** tab allows you to provide or change:
- Your display name
- Email address
- Username (this is the value that Coder uses throughout the platform, including
in Dev URLs and the CLI's SSH configuration)
in dev URLs and the CLI's SSH configuration)
- Your dotfiles URI to personalize your environments
- Your avatar

Expand Down
14 changes: 7 additions & 7 deletions guides/customization/custom-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ To demonstrate, we'll create a development image that utilizes

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

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

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

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

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

You can see the changes you're making in the web browser whose URL points to
your application.
8 changes: 4 additions & 4 deletions guides/deployments/code-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Kubernetes, you may want to consider Coder, our solution for developers and
development teams. Coder runs on Kubernetes and offers the following features in
addition to the base code-server functionality.

## Environment Consistency
## Environment consistency

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

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

## Developer Workflows
## Developer workflows

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

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

## Team Management
## Team management

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

<hr />

## Getting Started
## Getting started

Coder is free to try for 60 days. See our
[install guide](https://coder.com/docs/setup) for additional details.
2 changes: 1 addition & 1 deletion guides/ssl-certificates/cloudflare.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ cert-manager supports HTTP01 and DNS01 challenges, as well as
[many DNS providers](https://cert-manager.io/docs/configuration/acme/dns01/#supported-dns01-providers).
This guide, however, shows you how to use Cloudflare for DNS01 challenges. This
is necessary to issue wildcard certificates, which are required for Coder's
[Dev URLs](../../admin/devurls.md) feature.
[dev URLs](../../admin/devurls.md) feature.

First, get the Cloudflare API credentials for cert-manager to use; cert-manager
needs permission to add a temporary TXT record and delete it after the challenge
Expand Down
6 changes: 3 additions & 3 deletions guides/ssl-certificates/route53.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ authority.
This guide will show you how to install cert-manager v1.0.1 and set up your
cluster to issue Let's Encrypt certificates for your Coder installation so that
you can enable HTTPS on your Coder deployment. It will also show you how to
configure your Coder hostname and Dev URLs.
configure your Coder hostname and dev URLs.

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

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

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

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

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

At this point, you can return to **step 6** of the
Expand Down
Loading