Skip to content

Commit af0fdd8

Browse files
EdwardAngertEdwardAngert
committed
edit blockquotes
1 parent 0dab25c commit af0fdd8

File tree

13 files changed

+64
-63
lines changed

13 files changed

+64
-63
lines changed

‎docs/CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,7 @@ This mode is useful for testing HA or validating more complex setups.
117117

118118
### Deploying a PR
119119

120-
> You need to be a member or collaborator of the of
121-
> [coder](https://github.com/coder) GitHub organization to be able to deploy a
122-
> PR.
120+
You need to be a member or collaborator of the [coder](https://github.com/coder) GitHub organization to be able to deploy a PR.
123121

124122
You can test your changes by creating a PR deployment. There are two ways to do
125123
this:
@@ -257,8 +255,7 @@ Our frontend guide can be found [here](./contributing/frontend.md).
257255

258256
## Reviews
259257

260-
> The following information has been borrowed from
261-
> [Go's review philosophy](https://go.dev/doc/contribute#reviews).
258+
The following information has been borrowed from [Go's review philosophy](https://go.dev/doc/contribute#reviews).
262259

263260
Coder values thorough reviews. For each review comment that you receive, please
264261
"close" it by implementing the suggestion or providing an explanation on why the
@@ -346,6 +343,7 @@ Breaking changes can be triggered in two ways:
346343

347344
### Security
348345

346+
> [!IMPORTANT]
349347
> If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
350348
> to <security@coder.com>.
351349

‎docs/admin/infrastructure/validated-architectures/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ cloud/on-premise computing, containerization, and the Coder platform.
3636
| Reference architectures for up to 3,000 users | An approval of your architecture; the CVA solely provides recommendations and guidelines |
3737
| Best practices for building a Coder deployment | Recommendations for every possible deployment scenario |
3838

39-
> For higher level design principles and architectural best practices, see
40-
> Coder's
41-
> [Well-Architected Framework](https://coder.com/blog/coder-well-architected-framework).
39+
For higher level design principles and architectural best practices, see Coder's
40+
[Well-Architected Framework](https://coder.com/blog/coder-well-architected-framework).
4241

4342
## General concepts
4443

‎docs/admin/integrations/opentofu.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
<!-- Keeping this in as a placeholder for supporting OpenTofu. We should fix support for custom terraform binaries ASAP. -->
44

5-
> ⚠️ This guide is a work in progress. We do not officially support using custom
5+
> [!IMPORTANT]
6+
> This guide is a work in progress. We do not officially support using custom
67
> Terraform binaries in your Coder deployment. To track progress on the work,
78
> see this related [GitHub Issue](https://github.com/coder/coder/issues/12009).
89
910
Coder deployments support any custom Terraform binary, including
1011
[OpenTofu](https://opentofu.org/docs/) - an open source alternative to
1112
Terraform.
1213

13-
> You can read more about OpenTofu and Hashicorp's licensing in our
14-
> [blog post](https://coder.com/blog/hashicorp-license) on the Terraform
15-
> licensing changes.
14+
You can read more about OpenTofu and Hashicorp's licensing in our
15+
[blog post](https://coder.com/blog/hashicorp-license) on the Terraform licensing changes.
1616

1717
## Using a custom Terraform binary
1818

‎docs/admin/licensing/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ features, you can [request a trial](https://coder.com/trial) or
77

88
<!-- markdown-link-check-disable -->
99

10-
> If you are an existing customer, you can learn more our new Premium plan in
11-
> the [Coder v2.16 blog post](https://coder.com/blog/release-recap-2-16-0)
10+
You can learn more about Coder Premium in the [Coder v2.16 blog post](https://coder.com/blog/release-recap-2-16-0)
1211

1312
<!-- markdown-link-check-enable -->
1413

‎docs/admin/monitoring/health-check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If there is an issue, you may see one of the following errors reported:
4040
[`url.Parse`](https://pkg.go.dev/net/url#Parse). Example:
4141
`https://dev.coder.com/`.
4242

43-
> **Tip:** You can check this [here](https://go.dev/play/p/CabcJZyTwt9).
43+
You can use [the Go playground](https://go.dev/play/p/CabcJZyTwt9) for additional testing.
4444

4545
### EACS03
4646

‎docs/admin/monitoring/notifications/slack.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,11 @@ To build the server to receive webhooks and interact with Slack:
181181
Slack requires the bot to acknowledge when a user clicks on a URL action button.
182182
This is handled by setting up interactivity.
183183

184-
1. Under "Interactivity & Shortcuts" in your Slack app settings, set the Request
185-
URL to match the public URL of your web server's endpoint.
184+
Under "Interactivity & Shortcuts" in your Slack app settings, set the Request
185+
URL to match the public URL of your web server's endpoint.
186186

187-
> Notice: You can use any public endpoint that accepts and responds to POST
188-
> requests with HTTP 200. For temporary testing, you can set it to
189-
> `https://httpbin.org/status/200`.
187+
You can use any public endpoint that accepts and responds to POST requests with HTTP 200.
188+
For temporary testing, you can set it to `https://httpbin.org/status/200`.
190189

191190
Once this is set, Slack will send interaction payloads to your server, which
192191
must respond appropriately.

‎docs/admin/networking/port-forwarding.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ For more examples, see `coder port-forward --help`.
4848

4949
## Dashboard
5050

51-
> To enable port forwarding via the dashboard, Coder must be configured with a
52-
> [wildcard access URL](../../admin/setup/index.md#wildcard-access-url). If an
53-
> access URL is not specified, Coder will create
54-
> [a publicly accessible URL](../../admin/setup/index.md#tunnel) to reverse
55-
> proxy the deployment, and port forwarding will work.
56-
>
57-
> There is a
58-
> [DNS limitation](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.1)
59-
> where each segment of hostnames must not exceed 63 characters. If your app
60-
> name, agent name, workspace name and username exceed 63 characters in the
61-
> hostname, port forwarding via the dashboard will not work.
51+
To enable port forwarding via the dashboard, Coder must be configured with a
52+
[wildcard access URL](../../admin/setup/index.md#wildcard-access-url). If an
53+
access URL is not specified, Coder will create
54+
[a publicly accessible URL](../../admin/setup/index.md#tunnel) to reverse
55+
proxy the deployment, and port forwarding will work.
56+
57+
There is a
58+
[DNS limitation](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.1)
59+
where each segment of hostnames must not exceed 63 characters. If your app
60+
name, agent name, workspace name and username exceed 63 characters in the
61+
hostname, port forwarding via the dashboard will not work.
6262

6363
### From an coder_app resource
6464

@@ -176,12 +176,14 @@ must include credentials (set `credentials: "include"` if using `fetch`) or the
176176
requests cannot be authenticated and you will see an error resembling the
177177
following:
178178

179-
> Access to fetch at
180-
> '<https://coder.example.com/api/v2/applications/auth-redirect>' from origin
181-
> '<https://8000--dev--user--apps.coder.example.com>' has been blocked by CORS
182-
> policy: No 'Access-Control-Allow-Origin' header is present on the requested
183-
> resource. If an opaque response serves your needs, set the request's mode to
184-
> 'no-cors' to fetch the resource with CORS disabled.
179+
```text
180+
Access to fetch at
181+
'<https://coder.example.com/api/v2/applications/auth-redirect>' from origin
182+
'<https://8000--dev--user--apps.coder.example.com>' has been blocked by CORS
183+
policy: No 'Access-Control-Allow-Origin' header is present on the requested
184+
resource. If an opaque response serves your needs, set the request's mode to
185+
'no-cors' to fetch the resource with CORS disabled.
186+
```
185187

186188
#### Headers
187189

‎docs/admin/networking/workspace-proxies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ CODER_TLS_KEY_FILE="<key_file_location>"
104104

105105
### Running on Kubernetes
106106

107-
Make a `values-wsproxy.yaml` with the workspace proxy configuration:
107+
Make a `values-wsproxy.yaml` with the workspace proxy configuration.
108108

109-
> Notice the `workspaceProxy` configuration which is `false` by default in the
110-
> coder Helm chart.
109+
Notice the `workspaceProxy` configuration which is `false` by default in the
110+
Coder Helm chart:
111111

112112
```yaml
113113
coder:

‎docs/admin/provisioners.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,9 @@ tags.
104104

105105
## Global PSK (Not Recommended)
106106

107-
> Global pre-shared keys (PSK) make it difficult to rotate keys or isolate
108-
> provisioners.
109-
>
110-
> We do not recommend using global PSK.
107+
We do not recommend using global PSK.
108+
109+
Global pre-shared keys (PSK) make it difficult to rotate keys or isolate provisioners.
111110

112111
A deployment-wide PSK can be used to authenticate any provisioner. To use a
113112
global PSK, set a
@@ -158,7 +157,7 @@ coder templates push on-prem-chicago \
158157

159158
This can also be done in the UI when building a template:
160159

161-
> ![template tags](../images/admin/provisioner-tags.png)
160+
![template tags](../images/admin/provisioner-tags.png)
162161

163162
Alternatively, a template can target a provisioner via
164163
[workspace tags](https://github.com/coder/coder/tree/main/examples/workspace-tags)

‎docs/admin/security/0001_user_apikeys_invalidation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ failed to check whether the API key corresponds to a deleted user.
4242

4343
## Indications of Compromise
4444

45-
> 💡 Automated remediation steps in the upgrade purge all affected API keys.
45+
> [!TIP]
46+
> Automated remediation steps in the upgrade purge all affected API keys.
4647
> Either perform the following query before upgrade or run it on a backup of
4748
> your database from before the upgrade.
4849
@@ -81,7 +82,8 @@ Otherwise, the following information will be reported:
8182
- User API key ID
8283
- Time the affected API key was last used
8384

84-
> 💡 If your license includes the
85+
> [!TIP]
86+
> If your license includes the
8587
> [Audit Logs](https://coder.com/docs/admin/audit-logs#filtering-logs) feature,
8688
> you can then query all actions performed by the above users by using the
8789
> filter `email:$USER_EMAIL`.

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

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,22 @@ The following database fields are currently encrypted:
2626

2727
Additional database fields may be encrypted in the future.
2828

29-
> Implementation notes: each encrypted database column `$C` has a corresponding
30-
> `$C_key_id` column. This column is used to determine which encryption key was
31-
> used to encrypt the data. This allows Coder to rotate encryption keys without
32-
> invalidating existing tokens, and provides referential integrity for encrypted
33-
> data.
34-
>
35-
> The `$C_key_id` column stores the first 7 bytes of the SHA-256 hash of the
36-
> encryption key used to encrypt the data.
37-
>
38-
> Encryption keys in use are stored in `dbcrypt_keys`. This table stores a
39-
> record of all encryption keys that have been used to encrypt data. Active keys
40-
> have a null `revoked_key_id` column, and revoked keys have a non-null
41-
> `revoked_key_id` column. You cannot revoke a key until you have rotated all
42-
> values using that key to a new key.
29+
### Implementation notes
30+
31+
Each encrypted database column `$C` has a corresponding
32+
`$C_key_id` column. This column is used to determine which encryption key was
33+
used to encrypt the data. This allows Coder to rotate encryption keys without
34+
invalidating existing tokens, and provides referential integrity for encrypted
35+
data.
36+
37+
The `$C_key_id` column stores the first 7 bytes of the SHA-256 hash of the
38+
encryption key used to encrypt the data.
39+
40+
Encryption keys in use are stored in `dbcrypt_keys`. This table stores a
41+
record of all encryption keys that have been used to encrypt data. Active keys
42+
have a null `revoked_key_id` column, and revoked keys have a non-null
43+
`revoked_key_id` column. You cannot revoke a key until you have rotated all
44+
values using that key to a new key.
4345

4446
## Enabling encryption
4547

‎docs/admin/security/index.md

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

88
## Security Advisories
99

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

‎docs/admin/setup/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ full list of the options, run `coder server --help` or see our
1010
external URL that users and workspaces use to connect to Coder (e.g.
1111
<https://coder.example.com>). This should not be localhost.
1212

13-
> Access URL should be an external IP address or domain with DNS records
14-
> pointing to Coder.
13+
Access URL should be an external IP address or domain with DNS records pointing to Coder.
1514

1615
### Tunnel
1716

@@ -108,6 +107,7 @@ deployment information. Use `CODER_PG_CONNECTION_URL` to set the database that
108107
Coder connects to. If unset, PostgreSQL binaries will be downloaded from Maven
109108
(<https://repo1.maven.org/maven2>) and store all data in the config root.
110109

110+
> [!NOTE]
111111
> Postgres 13 is the minimum supported version.
112112

113113
If you are using the built-in PostgreSQL deployment and need to use `psql` (aka

0 commit comments

Comments
 (0)