Skip to content

Commit dc9f67b

Browse files
EdwardAngertEdwardAngert
committed
gfm alerts all around
1 parent 50d4d50 commit dc9f67b

File tree

27 files changed

+137
-269
lines changed

27 files changed

+137
-269
lines changed

‎.vscode/markdown.code-snippets

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"prefix": "#alert",
77
"body": [
88
"> [!${1|CAUTION,IMPORTANT,NOTE,TIP,WARNING|}]",
9-
"> ${TM_SELECTED_TEXT:${2:add info here}}\n\n"
9+
"> ${TM_SELECTED_TEXT:${2:add info here}}\n"
1010
],
1111
"description": "callout admonition caution important note tip warning"
1212
},
@@ -23,9 +23,8 @@
2323
"premium-feature": {
2424
"prefix": "#premium-feature",
2525
"body": [
26-
"<blockquote class=\"info\">\n",
27-
"${1:feature} ${2|is,are|} an Enterprise and Premium feature. [Learn more](https://coder.com/pricing#compare-plans).\n",
28-
"</blockquote>"
26+
"> [!NOTE]\n",
27+
"> ${1:feature} ${2|is,are|} an Enterprise and Premium feature. [Learn more](https://coder.com/pricing#compare-plans).\n"
2928
]
3029
},
3130
"tabs": {

‎docs/admin/external-auth.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,8 @@ The Redirect URI for Gitea should be
120120

121121
### GitHub
122122

123-
<blockquote class="admonition tip">
124-
125-
If you don't require fine-grained access control, it's easier to [configure a GitHub OAuth app](#configure-a-github-oauth-app).
126-
127-
</blockquote>
123+
> [!TIP]
124+
> If you don't require fine-grained access control, it's easier to [configure a GitHub OAuth app](#configure-a-github-oauth-app).
128125
129126
```env
130127
CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED_ID"
@@ -224,24 +221,18 @@ CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
224221

225222
## Multiple External Providers
226223

227-
<blockquote class="info">
228-
229-
Multiple providers is an Enterprise and Premium feature.
230-
[Learn more](https://coder.com/pricing#compare-plans).
231-
232-
</blockquote>
224+
> [!NOTE]
225+
> Multiple providers is an Enterprise and Premium feature.
226+
> [Learn more](https://coder.com/pricing#compare-plans).
233227
234228
Below is an example configuration with multiple providers:
235229

236-
<blockquote class="admonition warning">
237-
238-
**Note:** To support regex matching for paths like `github\.com/org`, add the following `git config` line to the [Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script):
239-
240-
```shell
241-
git config --global credential.useHttpPath true
242-
```
243-
244-
</blockquote>
230+
> [!IMPORTANT]
231+
> To support regex matching for paths like `github\.com/org`, add the following `git config` line to the [Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script):
232+
>
233+
> ```shell
234+
> git config --global credential.useHttpPath true
235+
> ```
245236
246237
```env
247238
# Provider 1) github.com

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

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,16 @@ Since Coder's performance is highly dependent on the templates and workflows you
3636
support, you may wish to use our internal scale testing utility against your own
3737
environments.
3838

39-
<blockquote class="admonition important">
40-
41-
This utility is experimental.
42-
43-
It is not subject to any compatibility guarantees and may cause interruptions
44-
for your users.
45-
To avoid potential outages and orphaned resources, we recommend that you run
46-
scale tests on a secondary "staging" environment or a dedicated
47-
[Kubernetes playground cluster](https://github.com/coder/coder/tree/main/scaletest/terraform).
48-
49-
Run it against a production environment at your own risk.
50-
51-
</blockquote>
39+
> [!IMPORTANT]
40+
> This utility is experimental.
41+
>
42+
> It is not subject to any compatibility guarantees and may cause interruptions
43+
> for your users.
44+
> To avoid potential outages and orphaned resources, we recommend that you run
45+
> scale tests on a secondary "staging" environment or a dedicated
46+
> [Kubernetes playground cluster](https://github.com/coder/coder/tree/main/scaletest/terraform).
47+
>
48+
> Run it against a production environment at your own risk.
5249
5350
### Create workspaces
5451

‎docs/admin/integrations/jfrog-artifactory.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,8 @@ To set this up, follow these steps:
131131
}
132132
```
133133

134-
<blockquote class="info">
135-
136-
The admin-level access token is used to provision user tokens and is never exposed to developers or stored in workspaces.
137-
138-
</blockquote>
134+
> [!NOTE]
135+
> The admin-level access token is used to provision user tokens and is never exposed to developers or stored in workspaces.
139136

140137
If you don't want to use the official modules, you can read through the [example template](https://github.com/coder/coder/tree/main/examples/jfrog/docker), which uses Docker as the underlying compute. The
141138
same concepts apply to all compute types.

‎docs/admin/integrations/jfrog-xray.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,11 @@ workspaces using Coder's [JFrog Xray Integration](https://github.com/coder/coder
5656
--set artifactory.secretName="jfrog-token"
5757
```
5858

59-
<blockquote class="admonition warning">
60-
61-
To authenticate with the Artifactory registry, you may need to
62-
create a [Docker config](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-advanced-topics) and use it in the
63-
`imagePullSecrets` field of the Kubernetes Pod. See the [Defining ImagePullSecrets for Coder workspaces](../../tutorials/image-pull-secret.md) guide for more
64-
information.
65-
66-
</blockquote>
59+
> [!IMPORTANT]
60+
> To authenticate with the Artifactory registry, you may need to
61+
> create a [Docker config](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-advanced-topics) and use it in the
62+
> `imagePullSecrets` field of the Kubernetes Pod.
63+
> See the [Defining ImagePullSecrets for Coder workspaces](../../tutorials/image-pull-secret.md) guide for more information.
6764
6865
## Validate your installation
6966

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

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,12 @@ Coder's current activity and usage. It may be necessary to increase the
117117
resources allocated to Coder's database. Alternatively, you can raise the
118118
configured threshold to a higher value (this will not address the root cause).
119119

120-
<blockquote class="admonition tip">
121-
122-
You can enable
123-
[detailed database metrics](../../reference/cli/server.md#--prometheus-collect-db-metrics)
124-
in Coder's Prometheus endpoint. If you have
125-
[tracing enabled](../../reference/cli/server.md#--trace), these traces may also
126-
contain useful information regarding Coder's database activity.
127-
128-
</blockquote>
120+
> [!TIP]
121+
> You can enable
122+
> [detailed database metrics](../../reference/cli/server.md#--prometheus-collect-db-metrics)
123+
> in Coder's Prometheus endpoint. If you have
124+
> [tracing enabled](../../reference/cli/server.md#--trace), these traces may also
125+
> contain useful information regarding Coder's database activity.
129126
130127
## DERP
131128

@@ -150,12 +147,9 @@ This is not necessarily a fatal error, but a possible indication of a
150147
misconfigured reverse HTTP proxy. Additionally, while workspace users should
151148
still be able to reach their workspaces, connection performance may be degraded.
152149

153-
<blockquote class="admonition note">
154-
155-
**Note:** This may also be shown if you have
156-
[forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
157-
158-
</blockquote>
150+
> [!NOTE]
151+
> This may also be shown if you have
152+
> [forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
159153
160154
**Solution:** ensure that any proxies you use allow connection upgrade with the
161155
`Upgrade: derp` header.
@@ -305,13 +299,10 @@ that they are able to successfully connect to Coder. Otherwise, ensure
305299
[`--provisioner-daemons`](../../reference/cli/server.md#--provisioner-daemons)
306300
is set to a value greater than 0.
307301

308-
<blockquote class="admonition note">
309-
310-
**Note:** This may be a transient issue if you are currently in the process of
302+
> [!NOTE]
303+
> This may be a transient issue if you are currently in the process of
311304
updating your deployment.
312305

313-
</blockquote>
314-
315306
### EPD02
316307

317308
#### Provisioner Daemon Version Mismatch
@@ -324,13 +315,10 @@ of API incompatibility.
324315
**Solution:** Update the provisioner daemon to match the currently running
325316
version of Coder.
326317

327-
<blockquote class="admonition note">
328-
329-
**Note:** This may be a transient issue if you are currently in the process of
318+
> [!NOTE]
319+
> This may be a transient issue if you are currently in the process of
330320
updating your deployment.
331321

332-
</blockquote>
333-
334322
### EPD03
335323

336324
#### Provisioner Daemon API Version Mismatch
@@ -343,13 +331,10 @@ connect to Coder.
343331
**Solution:** Update the provisioner daemon to match the currently running
344332
version of Coder.
345333

346-
<blockquote class="admonition note">
347-
348-
**Note:** This may be a transient issue if you are currently in the process of
334+
> [!NOTE]
335+
> This may be a transient issue if you are currently in the process of
349336
updating your deployment.
350337

351-
</blockquote>
352-
353338
### EUNKNOWN
354339

355340
#### Unknown Error

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -242,12 +242,9 @@ notification is indicated on the right hand side of this table.
242242

243243
## Delivery Preferences
244244

245-
<blockquote class="info">
246-
247-
Delivery preferences is an Enterprise and Premium feature.
248-
[Learn more](https://coder.com/pricing#compare-plans).
249-
250-
</blockquote>
245+
> [!NOTE]
246+
> Delivery preferences is an Enterprise and Premium feature.
247+
> [Learn more](https://coder.com/pricing#compare-plans).
251248
252249
Administrators can configure which delivery methods are used for each different
253250
[event type](#event-types).

‎docs/admin/networking/index.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -172,12 +172,9 @@ more.
172172

173173
## Browser-only connections
174174

175-
<blockquote class="info">
176-
177-
Browser-only connections is an Enterprise and Premium feature.
178-
[Learn more](https://coder.com/pricing#compare-plans).
179-
180-
</blockquote>
175+
> [!NOTE]
176+
> Browser-only connections is an Enterprise and Premium feature.
177+
> [Learn more](https://coder.com/pricing#compare-plans).
181178
182179
Some Coder deployments require that all access is through the browser to comply
183180
with security policies. In these cases, pass the `--browser-only` flag to
@@ -189,12 +186,9 @@ via the web terminal and
189186

190187
### Workspace Proxies
191188

192-
<blockquote class="info">
193-
194-
Workspace proxies are an Enterprise and Premium feature.
195-
[Learn more](https://coder.com/pricing#compare-plans).
196-
197-
</blockquote>
189+
> [!NOTE]
190+
> Workspace proxies are an Enterprise and Premium feature.
191+
> [Learn more](https://coder.com/pricing#compare-plans).
198192
199193
Workspace proxies are a Coder Enterprise feature that allows you to provide
200194
low-latency browser experiences for geo-distributed teams.

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,12 +131,9 @@ to the app.
131131

132132
### Configure maximum port sharing level
133133

134-
<blockquote class="info">
135-
136-
Configuring port sharing level is an Enterprise and Premium feature.
137-
[Learn more](https://coder.com/pricing#compare-plans).
138-
139-
</blockquote>
134+
> [!NOTE]
135+
> Configuring port sharing level is an Enterprise and Premium feature.
136+
> [Learn more](https://coder.com/pricing#compare-plans).
140137
141138
Premium-licensed template admins can control the maximum port sharing level for
142139
workspaces under a given template in the template settings. By default, the

‎docs/admin/setup/appearance.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# Appearance
22

3-
<blockquote class="info">
4-
5-
Customizing Coder's appearance is an Enterprise and Premium feature.
6-
[Learn more](https://coder.com/pricing#compare-plans).
7-
8-
</blockquote>
3+
> [!NOTE]
4+
> Customizing Coder's appearance is an Enterprise and Premium feature.
5+
> [Learn more](https://coder.com/pricing#compare-plans).
96
107
Customize the look of your Coder deployment to meet your enterprise
118
requirements.

0 commit comments

Comments
 (0)