docs: correct broken CLI commands and flags from drift sweep by nickvigilante · Pull Request #28098 · coder/coder · GitHub
Skip to content
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
2 changes: 1 addition & 1 deletion docs/admin/infrastructure/scale-utility.md
5 changes: 3 additions & 2 deletions docs/admin/integrations/dx-data-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ If your organization already uses the Coder-DX integration, you can find a list

### CLI

Use `users list` to export the list of users to a CSV file:
Use `users list` with `jq` to export the list of users to a CSV file:

```sh
coder users list > users.csv
coder users list --output json | \
jq -r '["username","email","created_at","status"], (.[] | [.username, .email, .created_at, .status]) | @csv' > users.csv
```

Visit the [users list](../../reference/cli/users_list.md) documentation for more options.
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
authentication (MFA). It is your responsibility to ensure the auth provider
enforces MFA correctly.

## Configuring SSO

Check warning on line 8 in docs/admin/users/index.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.

- [OpenID Connect](./oidc-auth/index.md) (e.g. Okta, KeyCloak, PingFederate, Azure AD)
- [GitHub](./github-auth.md) (or GitHub Enterprise)
Expand Down Expand Up @@ -170,7 +170,7 @@
> Resetting a user's password, e.g., the initial `owner` role-based user, only
> works when run on the host running the Coder control plane.

### Resetting a password on Kubernetes

Check warning on line 173 in docs/admin/users/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

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

```sh
kubectl exec -it deployment/coder -n coder -- /bin/bash
Expand Down Expand Up @@ -235,10 +235,11 @@

### CLI

Use `users list` to export the list of users to a CSV file:
Use `users list` with `jq` to export the list of users to a CSV file:

```sh
coder users list > users.csv
coder users list --output json | \
jq -r '["username","email","created_at","status"], (.[] | [.username, .email, .created_at, .status]) | @csv' > users.csv
```

Visit the [users list](../../reference/cli/users_list.md) documentation for more options.
Expand Down
5 changes: 1 addition & 4 deletions docs/ai-coder/github-to-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

This guide walks you through how to configure GitHub and Coder together so that you can tag Coder in a GitHub issue comment, and securely delegate work to coding agents in a Coder Task.

## Implementing the GHA

Check warning on line 23 in docs/ai-coder/github-to-tasks.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

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

The below steps outline how to use the Coder [Create Task Action GHA](https://github.com/coder/create-task-action) in a GitHub workflow to solve a bug. The guide makes the following assumptions:

Expand Down Expand Up @@ -99,9 +99,6 @@
```sh
# List all templates in your organization
coder templates list

# List templates in a specific organization
coder templates list --org your-org-name
```

You can also choose to modify the other [input parameters](https://github.com/coder/create-task-action?tab=readme-ov-file#inputs) to better fit your desired workflow.
Expand Down Expand Up @@ -229,7 +226,7 @@

**Solution:**

1. Verify the template name using: `coder templates list --org your-org-name`
1. Verify the template name using: `coder templates list`
1. Update the `coder-template-name` input in your workflow file to match exactly, or input secret or variable saved in GitHub
1. Ensure the template exists in the organization specified by `coder-organization`

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/index.md
Loading