Skip to content

docs: fix P2/P3 typos and syntax errors from drift sweep #28101

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.

Sign up for GitHub

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

Draft
nickvigilante wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: fix P2/P3 typos and syntax errors from drift sweep #28101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/about/contributing/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@
- Improve error handling
- Optimize performance

### Making changes

Check warning on line 295 in docs/about/contributing/modules.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Making'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. **Identify the issue**: Reproduce the problem or identify the improvement needed
2. **Make focused changes**: Keep modifications minimal and targeted
Expand Down Expand Up @@ -342,7 +342,7 @@

```sh
git add .
git commit -m "feat(git-clone):add git-clone module"
git commit -m "feat(git-clone): add git-clone module"
```

4. **Open a pull request**:
Expand All @@ -352,7 +352,7 @@

## Common issues and solutions

### Testing problems

Check warning on line 355 in docs/about/contributing/modules.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Testing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

**Issue**: Tests fail with network errors
**Solution**: Ensure Docker is running with `--network=host` support
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/networking/port-forwarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
name, agent name, workspace name and username exceed 63 characters in the
hostname, port forwarding via the dashboard will not work.

### From an coder_app resource
### From a coder_app resource

One way to port forward is to configure a `coder_app` resource in the
workspace's template. This approach shows a visual application icon in the
Expand Down Expand Up @@ -110,7 +110,7 @@

![Port forwarding from an app in the UI](../../images/networking/portforwarddashboard.png)

## Accessing workspace ports

Check warning on line 113 in docs/admin/networking/port-forwarding.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Accessing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Another way to port forward in the dashboard is to use the "Open Ports" button
to specify an arbitrary port. Coder will also detect if apps inside the
Expand All @@ -119,7 +119,7 @@

![Port forwarding in the UI](../../images/networking/listeningports.png)

### Sharing ports

Check warning on line 122 in docs/admin/networking/port-forwarding.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Sharing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

We allow developers to share ports as URLs, either with other authenticated
coder users or publicly. Using the open ports interface, developers can assign a
Expand Down Expand Up @@ -161,7 +161,7 @@

![Max port sharing level in the UI](../../images/networking/portsharingmax.png)

### Configuring port protocol

Check warning on line 164 in docs/admin/networking/port-forwarding.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Configuring'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Both listening and shared ports can be configured to use either `HTTP` or
`HTTPS` to connect to the port. For listening ports the protocol selector
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ and predictability.
If you encounter a situation where you need to override template settings for
variables, you can employ a straightforward solution:

1. Create a `terraform.tfvars` file in in the template directory:
1. Create a `terraform.tfvars` file in the template directory:

```tf
coder_image = newimage:tag
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/users/idp-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ role sync at the organization level.
1. Confirm you have the [Coder CLI](../../install/index.md) installed and are
logged in with a user who is an Owner or has an Organization Admin role.

1. To fetch the current group sync settings for an organization, run the
1. To fetch the current role sync settings for an organization, run the
following:

```sh
Expand Down Expand Up @@ -388,7 +388,7 @@ settings, a user's memberships will update when they log out and log back in.
"cbdcf774-4123-4118-8cd9-b3f502c84dfb"
],
"sales": [
"d79144d9-b30a-555a-9af8-7dac83b2q4ec",
"d79144d9-b30a-555a-9af8-7dac83b2q4ec"
]
},
"organization_assign_default": true
Expand Down
6 changes: 3 additions & 3 deletions docs/ai-coder/tasks-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Migrating Task Templates for Coder version 2.28.0

Check warning on line 1 in docs/ai-coder/tasks-migration.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Migrating'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

> [!WARNING]
> Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers.
Expand Down Expand Up @@ -76,7 +76,7 @@
terraform {
required_providers {
coder = {
source = "coder/coder
source = "coder/coder"
}
}
}
Expand Down Expand Up @@ -132,8 +132,8 @@
terraform {
required_providers {
coder = {
source = "coder/coder
version = ">= 2.13.0
source = "coder/coder"
version = ">= 2.13.0"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

## SSH

### Through with the CLI
### Through the CLI

Coder will use the optimal path for an SSH connection (determined by your
deployment's [networking configuration](../../admin/infrastructure/index.md))
Expand All @@ -43,7 +43,7 @@
> SSH command. For users who need the full functionality of SSH, use the
> configuration method below.

### Running remote commands with quoting

Check warning on line 46 in docs/user-guides/workspace-access/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading 

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Arguments after `--` are joined with spaces into a single command
string before being sent to the workspace agent (per
Expand Down
Loading