Skip to content

Commit 0dab25c

Browse files
EdwardAngertEdwardAngert
committed
more > Note
1 parent ca70325 commit 0dab25c

32 files changed

+120
-78
lines changed

‎docs/CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ this:
142142
name and PR number, etc.
143143
- `-y` or `--yes`, will skip the CLI confirmation prompt.
144144

145-
> Note: PR deployment will be re-deployed automatically when the PR is updated.
145+
> [!NOTE]
146+
> PR deployment will be re-deployed automatically when the PR is updated.
146147
> It will use the last values automatically for redeployment.
147148
148149
Once the deployment is finished, a unique link and credentials will be posted in

‎docs/admin/external-auth.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
9090
CODER_EXTERNAL_AUTH_0_AUTH_URL="https://login.microsoftonline.com/<TENANT ID>/oauth2/authorize"
9191
```
9292

93-
> Note: Your app registration in Entra ID requires the `vso.code_write` scope
93+
> [!NOTE]
94+
> Your app registration in Entra ID requires the `vso.code_write` scope
9495
9596
### Bitbucket Server
9697

@@ -176,7 +177,8 @@ CODER_EXTERNAL_AUTH_0_VALIDATE_URL="https://your-domain.com/oauth/token/info"
176177
CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
177178
```
178179

179-
> Note: The `REGEX` variable must be set if using a custom git domain.
180+
> [!NOTE]
181+
> The `REGEX` variable must be set if using a custom git domain.
180182
181183
## Custom scopes
182184

‎docs/admin/infrastructure/scale-utility.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ hardware sizing recommendations.
2828
| Kubernetes (GKE) | 4 cores | 16 GB | 2 | db-custom-8-30720 | 2000 | 50 | 2000 simulated | `v2.8.4` | Feb 28, 2024 |
2929
| Kubernetes (GKE) | 2 cores | 4 GB | 2 | db-custom-2-7680 | 1000 | 50 | 1000 simulated | `v2.10.2` | Apr 26, 2024 |
3030

31-
> Note: A simulated connection reads and writes random data at 40KB/s per connection.
31+
> [!NOTE]
32+
> A simulated connection reads and writes random data at 40KB/s per connection.
3233
3334
## Scale testing utility
3435

‎docs/admin/monitoring/logs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Agent logs are also stored in the workspace filesystem by default:
4343
[azure-windows](https://github.com/coder/coder/blob/2cfadad023cb7f4f85710cff0b21ac46bdb5a845/examples/templates/azure-windows/Initialize.ps1.tftpl#L64))
4444
to see where logs are stored.
4545

46-
> Note: Logs are truncated once they reach 5MB in size.
46+
> [!NOTE]
47+
> Logs are truncated once they reach 5MB in size.
4748
4849
Startup script logs are also stored in the temporary directory of macOS and
4950
Linux workspaces.

‎docs/admin/networking/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ networking logic.
1818

1919
In order for clients and workspaces to be able to connect:
2020

21-
> **Note:** We strongly recommend that clients connect to Coder and their
21+
> [!NOTE]
22+
> We strongly recommend that clients connect to Coder and their
2223
> workspaces over a good quality, broadband network connection. The following
2324
> are minimum requirements:
2425
>
@@ -33,7 +34,8 @@ In order for clients and workspaces to be able to connect:
3334

3435
In order for clients to be able to establish direct connections:
3536

36-
> **Note:** Direct connections via the web browser are not supported. To improve
37+
> [!NOTE]
38+
> Direct connections via the web browser are not supported. To improve
3739
> latency for browser-based applications running inside Coder workspaces in
3840
> regions far from the Coder control plane, consider deploying one or more
3941
> [workspace proxies](./workspace-proxies.md).

‎docs/admin/networking/stun.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# STUN and NAT
22

3-
> [Session Traversal Utilities for NAT (STUN)](https://www.rfc-editor.org/rfc/rfc8489.html)
4-
> is a protocol used to assist applications in establishing peer-to-peer
5-
> communications across Network Address Translations (NATs) or firewalls.
6-
>
7-
> [Network Address Translation (NAT)](https://en.wikipedia.org/wiki/Network_address_translation)
8-
> is commonly used in private networks to allow multiple devices to share a
9-
> single public IP address. The vast majority of home and corporate internet
10-
> connections use at least one level of NAT.
3+
[Session Traversal Utilities for NAT (STUN)](https://www.rfc-editor.org/rfc/rfc8489.html)
4+
is a protocol used to assist applications in establishing peer-to-peer
5+
communications across Network Address Translations (NATs) or firewalls.
6+
7+
[Network Address Translation (NAT)](https://en.wikipedia.org/wiki/Network_address_translation)
8+
is commonly used in private networks to allow multiple devices to share a
9+
single public IP address. The vast majority of home and corporate internet
10+
connections use at least one level of NAT.
1111

1212
## Overview
1313

@@ -33,8 +33,9 @@ counterpart can be reached. Once communication succeeds in one direction, we can
3333
inspect the source address of the received packet to determine the return
3434
address.
3535

36-
> The below glosses over a lot of the complexity of traversing NATs. For a more
37-
> in-depth technical explanation, see
36+
> [!TIP]
37+
> The below glosses over a lot of the complexity of traversing NATs.
38+
> For a more in-depth technical explanation, see
3839
> [How NAT traversal works (tailscale.com)](https://tailscale.com/blog/how-nat-traversal-works).
3940
4041
At a high level, STUN works like this:

‎docs/admin/provisioners.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,8 @@ This is illustrated in the below table:
226226
| scope=user owner=aaa environment=on-prem datacenter=chicago | scope=user owner=aaa environment=on-prem datacenter=new_york | ✅ | ❌ |
227227
| scope=organization owner= environment=on-prem | scope=organization owner= environment=on-prem | ❌ | ❌ |
228228

229-
> **Note to maintainers:** to generate this table, run the following command and
229+
> [!TIP]
230+
> To generate this table, run the following command and
230231
> copy the output:
231232
>
232233
> ```go

‎docs/admin/security/database-encryption.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Additional database fields may be encrypted in the future.
4343
4444
## Enabling encryption
4545

46-
> NOTE: Enabling encryption does not encrypt all existing data. To encrypt
46+
> [!NOTE]
47+
> Enabling encryption does not encrypt all existing data. To encrypt
4748
> existing data, see [rotating keys](#rotating-keys) below.
4849
4950
- Ensure you have a valid backup of your database. **Do not skip this step.** If
@@ -115,7 +116,8 @@ data:
115116
This command will re-encrypt all tokens with the specified new encryption key.
116117
We recommend performing this action during a maintenance window.
117118

118-
> Note: this command requires direct access to the database. If you are using
119+
> [!NOTE]
120+
> this command requires direct access to the database. If you are using
119121
> the built-in PostgreSQL database, you can run
120122
> [`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md)
121123
> to get the connection URL.
@@ -138,7 +140,8 @@ To disable encryption, perform the following actions:
138140
This command will decrypt all encrypted user tokens and revoke all active
139141
encryption keys.
140142

141-
> Note: for `decrypt` command, the equivalent environment variable for
143+
> [!NOTE]
144+
> for `decrypt` command, the equivalent environment variable for
142145
> `--keys` is `CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS` and not
143146
> `CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS`. This is explicitly named differently
144147
> to help prevent accidentally decrypting data.
@@ -152,7 +155,8 @@ To disable encryption, perform the following actions:
152155

153156
## Deleting Encrypted Data
154157

155-
> NOTE: This is a destructive operation.
158+
> [!CAUTION]
159+
> This is a destructive operation.
156160

157161
To delete all encrypted data from your database, perform the following actions:
158162

‎docs/admin/security/secrets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ Users can view their public key in their account settings:
3838

3939
![SSH keys in account settings](../../images/ssh-keys.png)
4040

41-
> Note: SSH keys are never stored in Coder workspaces, and are fetched only when
41+
> [!NOTE]
42+
> SSH keys are never stored in Coder workspaces, and are fetched only when
4243
> SSH is invoked. The keys are held in-memory and never written to disk.
4344
4445
## Dynamic Secrets

‎docs/admin/setup/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ coder server
4444
or running [coder_apps](../templates/index.md) on an absolute path. Set this to
4545
a wildcard subdomain that resolves to Coder (e.g. `*.coder.example.com`).
4646

47-
> Note: We do not recommend using a top-level-domain for Coder wildcard access
47+
> [!NOTE]
48+
> We do not recommend using a top-level-domain for Coder wildcard access
4849
> (for example `*.workspaces`), even on private networks with split-DNS. Some
4950
> browsers consider these "public" domains and will refuse Coder's cookies,
5051
> which are vital to the proper operation of this feature.

‎docs/admin/templates/extending-templates/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ Persistent resources stay provisioned when workspaces are stopped, where as
4949
ephemeral resources are destroyed and recreated on restart. All resources are
5050
destroyed when a workspace is deleted.
5151

52-
> You can read more about how resource behavior and workspace state in the
53-
> [workspace lifecycle documentation](../../../user-guides/workspace-lifecycle.md).
52+
You can read more about how resource behavior and workspace state in the [workspace lifecycle documentation](../../../user-guides/workspace-lifecycle.md).
5453

5554
Template resources follow the
5655
[behavior of Terraform resources](https://developer.hashicorp.com/terraform/language/resources/behavior#how-terraform-applies-a-configuration)
@@ -65,6 +64,7 @@ When a workspace is deleted, the Coder server essentially runs a
6564
[terraform destroy](https://www.terraform.io/cli/commands/destroy) to remove all
6665
resources associated with the workspace.
6766

67+
> [!TIP]
6868
> Terraform's
6969
> [prevent-destroy](https://www.terraform.io/language/meta-arguments/lifecycle#prevent_destroy)
7070
> and

‎docs/admin/templates/extending-templates/process-logging.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
The workspace process logging feature allows you to log all system-level
44
processes executing in the workspace.
55

6-
> **Note:** This feature is only available on Linux in Kubernetes. There are
6+
> [!NOTE]
7+
> This feature is only available on Linux in Kubernetes. There are
78
> additional requirements outlined further in this document.
89
910
Workspace process logging adds a sidecar container to workspace pods that will
@@ -164,7 +165,8 @@ would like to add workspace process logging to, follow these steps:
164165
}
165166
```
166167

167-
> **Note:** If you are using the `envbox` template, you will need to update
168+
> [!NOTE]
169+
> If you are using the `envbox` template, you will need to update
168170
> the third argument to be
169171
> `"${local.exectrace_init_script}\n\nexec /envbox docker"` instead.
170172
@@ -212,7 +214,8 @@ would like to add workspace process logging to, follow these steps:
212214
}
213215
```
214216

215-
> **Note:** `exectrace` requires root privileges and a privileged container
217+
> [!NOTE]
218+
> `exectrace` requires root privileges and a privileged container
216219
> to attach probes to the kernel. This is a requirement of eBPF.
217220
218221
1. Add the following environment variable to your workspace pod:

‎docs/admin/templates/extending-templates/workspace-tags.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ added that can handle its combination of tags.
7171
Before releasing the template version with configurable workspace tags, ensure
7272
that every tag set is associated with at least one healthy provisioner.
7373

74-
> **Note:** It may be useful to run at least one provisioner with no additional
74+
> [!NOTE]
75+
> It may be useful to run at least one provisioner with no additional
7576
> tag restrictions that is able to take on any job.
7677
7778
### Parameters types

‎docs/admin/templates/managing-templates/dependencies.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ directory. When you next run
9494
[`coder templates push`](../../../reference/cli/templates_push.md), the lock
9595
file will be stored alongside with the other template source code.
9696

97-
> Note: Terraform best practices also recommend checking in your
97+
> [!NOTE]
98+
> Terraform best practices also recommend checking in your
9899
> `.terraform.lock.hcl` into Git or other VCS.
99100
100101
The next time a workspace is built from that template, Coder will make sure to

‎docs/admin/templates/managing-templates/image-management.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ practices around managing workspaces images for Coder.
1111
3. Allow developers to bring their own images and customizations with Dev
1212
Containers
1313

14-
> Note: An image is just one of the many properties defined within the template.
15-
> Templates can pull images from a public image registry (e.g. Docker Hub) or an
16-
> internal one, thanks to Terraform.
14+
An image is just one of the many properties defined within the template.
15+
Templates can pull images from a public image registry (e.g. Docker Hub) or an
16+
internal one, thanks to Terraform.
1717

1818
## Create a minimal base image
1919

‎docs/admin/templates/open-in-coder.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ resource "coder_agent" "dev" {
4646
}
4747
```
4848

49-
> Note: The `dir` attribute can be set in multiple ways, for example:
49+
> [!NOTE]
50+
> The `dir` attribute can be set in multiple ways, for example:
5051
>
5152
> - `~/coder`
5253
> - `/home/coder/coder`

‎docs/admin/templates/troubleshooting.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,17 @@ if [ $status -ne 0 ]; then
144144
fi
145145
```
146146

147-
> **Note:** We don't use `set -x` here because we're manually echoing the
147+
> [!NOTE]
148+
> We don't use `set -x` here because we're manually echoing the
148149
> commands. This protects against sensitive information being shown in the log.
149150
150151
This script tells us what command is being run and what the exit status is. If
151152
the exit status is non-zero, it means the command failed and we exit the script.
152153
Since we are manually checking the exit status here, we don't need `set -e` at
153154
the top of the script to exit on error.
154155

155-
> **Note:** If you aren't seeing any logs, check that the `dir` directive points
156+
> [!NOTE]
157+
> If you aren't seeing any logs, check that the `dir` directive points
156158
> to a valid directory in the file system.
157159
158160
## Slow workspace startup times

‎docs/admin/users/github-auth.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ GitHub will ask you for the following Coder parameters:
4747
`https://coder.domain.com`)
4848
- **User Authorization Callback URL**: Set to `https://coder.domain.com`
4949

50-
> Note: If you want to allow multiple coder deployments hosted on subdomains
51-
> e.g. coder1.domain.com, coder2.domain.com, to be able to authenticate with the
52-
> same GitHub OAuth app, then you can set **User Authorization Callback URL** to
53-
> the `https://domain.com`
50+
If you want to allow multiple Coder deployments hosted on subdomains, such as
51+
`coder1.domain.com`, `coder2.domain.com`, to authenticate with the
52+
same GitHub OAuth app, then you can set **User Authorization Callback URL** to
53+
the `https://domain.com`
5454

55-
Note the Client ID and Client Secret generated by GitHub. You will use these
55+
Take note of the Client ID and Client Secret generated by GitHub. You will use these
5656
values in the next step.
5757

5858
Coder will need permission to access user email addresses. Find the "Account
@@ -67,8 +67,8 @@ server:
6767
coder server --oauth2-github-allow-signups=true --oauth2-github-allowed-orgs="your-org" --oauth2-github-client-id="8d1...e05" --oauth2-github-client-secret="57ebc9...02c24c"
6868
```
6969

70-
> For GitHub Enterprise support, specify the
71-
> `--oauth2-github-enterprise-base-url` flag.
70+
> [!NOTE]
71+
> For GitHub Enterprise support, specify the `--oauth2-github-enterprise-base-url` flag.
7272
7373
Alternatively, if you are running Coder as a system service, you can achieve the
7474
same result as the command above by adding the following environment variables
@@ -81,11 +81,12 @@ CODER_OAUTH2_GITHUB_CLIENT_ID="8d1...e05"
8181
CODER_OAUTH2_GITHUB_CLIENT_SECRET="57ebc9...02c24c"
8282
```
8383

84-
**Note:** To allow everyone to signup using GitHub, set:
85-
86-
```env
87-
CODER_OAUTH2_GITHUB_ALLOW_EVERYONE=true
88-
```
84+
> [!NOTE]
85+
> To allow everyone to sign up using GitHub, set:
86+
>
87+
> ```env
88+
> CODER_OAUTH2_GITHUB_ALLOW_EVERYONE=true
89+
> ```
8990
9091
Once complete, run `sudo service coder restart` to reboot Coder.
9192

‎docs/admin/users/idp-sync.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,8 @@ Below are some details specific to individual OIDC providers.
521521
522522
### Active Directory Federation Services (ADFS)
523523
524-
> **Note:** Tested on ADFS 4.0, Windows Server 2019
524+
> [!NOTE]
525+
> Tested on ADFS 4.0, Windows Server 2019
525526
526527
1. In your Federation Server, create a new application group for Coder.
527528
Follow the steps as described in the [Windows Server documentation]

‎docs/admin/users/oidc-auth.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ signing in via OIDC as a new user. Coder will log the claim fields returned by
3232
the upstream identity provider in a message containing the string
3333
`got oidc claims`, as well as the user info returned.
3434

35-
> **Note:** If you need to ensure that Coder only uses information from the ID
35+
> [!NOTE]
36+
> If you need to ensure that Coder only uses information from the ID
3637
> token and does not hit the UserInfo endpoint, you can set the configuration
3738
> option `CODER_OIDC_IGNORE_USERINFO=true`.
3839
@@ -44,7 +45,8 @@ for the newly created user's email address.
4445
If your upstream identity provider users a different claim, you can set
4546
`CODER_OIDC_EMAIL_FIELD` to the desired claim.
4647

47-
> **Note** If this field is not present, Coder will attempt to use the claim
48+
> [!NOTE]
49+
> If this field is not present, Coder will attempt to use the claim
4850
> field configured for `username` as an email address. If this field is not a
4951
> valid email address, OIDC logins will fail.
5052
@@ -59,7 +61,8 @@ disable this behavior with the following setting:
5961
CODER_OIDC_IGNORE_EMAIL_VERIFIED=true
6062
```
6163

62-
> **Note:** This will cause Coder to implicitly treat all OIDC emails as
64+
> [!NOTE]
65+
> This will cause Coder to implicitly treat all OIDC emails as
6366
> "verified", regardless of what the upstream identity provider says.
6467
6568
### Usernames
@@ -70,7 +73,8 @@ claim field named `preferred_username` as the the username.
7073
If your upstream identity provider uses a different claim, you can set
7174
`CODER_OIDC_USERNAME_FIELD` to the desired claim.
7275

73-
> **Note:** If this claim is empty, the email address will be stripped of the
76+
> [!NOTE]
77+
> If this claim is empty, the email address will be stripped of the
7478
> domain, and become the username (e.g. `example@coder.com` becomes `example`).
7579
> To avoid conflicts, Coder may also append a random word to the resulting
7680
> username.

‎docs/admin/users/organizations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Organizations (Premium)
22

3-
> Note: Organizations requires a
3+
> [!NOTE]
4+
> Organizations requires a
45
> [Premium license](https://coder.com/pricing#compare-plans). For more details,
56
> [contact your account team](https://coder.com/contact).
67

0 commit comments

Comments
 (0)