Skip to content

Commit 1735d16

Browse files
Apply suggestions from code review
Co-authored-by: M Atif Ali <atif@coder.com>
1 parent 06c8b36 commit 1735d16

File tree

7 files changed

+9
-10
lines changed

7 files changed

+9
-10
lines changed

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ Breaking changes can be triggered in two ways:
343343

344344
### Security
345345

346-
> [!IMPORTANT]
346+
> [!CAUTION]
347347
> If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
348348
> to <security@coder.com>.
349349

docs/admin/security/database-encryption.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ data:
118118
This command will re-encrypt all tokens with the specified new encryption key.
119119
We recommend performing this action during a maintenance window.
120120

121-
> [!NOTE]
122-
> this command requires direct access to the database. If you are using
121+
> [!IMPORTANT]
122+
> This command requires direct access to the database. If you are using
123123
> the built-in PostgreSQL database, you can run
124124
> [`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md)
125125
> to get the connection URL.

docs/admin/security/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ For other security tips, visit our guide to
77

88
## Security Advisories
99

10-
> [!IMPORTANT]
10+
> [!CAUTION]
1111
> If you discover a vulnerability in Coder, please do not hesitate to report it
1212
> to us by following the instructions
1313
> [here](https://github.com/coder/coder/blob/main/SECURITY.md).

docs/admin/users/github-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ CODER_OAUTH2_GITHUB_CLIENT_ID="8d1...e05"
8181
CODER_OAUTH2_GITHUB_CLIENT_SECRET="57ebc9...02c24c"
8282
```
8383

84-
> [!NOTE]
84+
> [!TIP]
8585
> To allow everyone to sign up using GitHub, set:
8686
>
8787
> ```env

docs/admin/users/idp-sync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Below is an example that uses the `groups` claim and maps all groups prefixed by
107107
}
108108
```
109109

110-
> [!NOTE]
110+
> [!IMPORTANT]
111111
> You must specify Coder group IDs instead of group names. The fastest way to find
112112
> the ID for a corresponding group is by visiting
113113
> `https://coder.example.com/api/v2/groups`.

docs/admin/users/password-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you remove the admin user account (or forget the password), you can run the
1515
[`coder server create-admin-user`](../../reference/cli/server_create-admin-user.md)command
1616
on your server.
1717

18-
> [!NOTE]
18+
> [!IMPORTANT]
1919
> You must run this command on the same machine running the Coder server.
2020
> If you are running Coder on Kubernetes, this means using
2121
> [kubectl exec](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_exec/)

docs/user-guides/workspace-access/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,15 @@ each user to simplify the setup process.
4646

4747
1. Access Coder via SSH:
4848

49-
```console
49+
```shell
5050
coder config-ssh
5151
```
5252

5353
1. Run `coder config-ssh --dry-run` if you'd like to see the changes that will be
5454
before you proceed:
5555

56-
```bash
56+
```shell
5757
coder config-ssh --dry-run
58-
```
5958

6059
1. Confirm that you want to continue by typing **yes** and pressing enter. If
6160
successful, you'll see the following message:

0 commit comments

Comments
 (0)