Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 101b62d

Browse files
EdwardAngertmatifali
EdwardAngert
and
matifali
authored
docs: convert alerts to use GitHub Flavored Markdown (GFM) (coder#16850)
followup to coder#16761 thanks @lucasmelin ! + thanks: @ethanndickson @Parkreiner @matifali @aqandrew - [x] update snippet - [x] find/replace - [x] spot-check [preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule) (and others) --------- Co-authored-by: EdwardAngert <[email protected]> Co-authored-by: M Atif Ali <[email protected]>
1 parent e817713 commit 101b62d

File tree

86 files changed

+493
-562
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+493
-562
lines changed

‎.vscode/markdown.code-snippets

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
// For info about snippets, visit https://code.visualstudio.com/docs/editor/userdefinedsnippets
3+
// https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
34

4-
"admonition": {
5-
"prefix": "#callout",
5+
"alert": {
6+
"prefix": "#alert",
67
"body": [
7-
"<blockquote class=\"admonition ${1|caution,important,note,tip,warning|}\">\n",
8-
"${TM_SELECTED_TEXT:${2:add info here}}\n",
9-
"</blockquote>\n"
8+
"> [!${1|CAUTION,IMPORTANT,NOTE,TIP,WARNING|}]",
9+
"> ${TM_SELECTED_TEXT:${2:add info here}}\n"
1010
],
11-
"description": "callout admonition caution info note tip warning"
11+
"description": "callout admonition caution important note tip warning"
1212
},
1313
"fenced code block": {
1414
"prefix": "#codeblock",
@@ -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/CONTRIBUTING.md

+5-6
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:
@@ -142,7 +140,8 @@ this:
142140
name and PR number, etc.
143141
- `-y` or `--yes`, will skip the CLI confirmation prompt.
144142

145-
> Note: PR deployment will be re-deployed automatically when the PR is updated.
143+
> [!NOTE]
144+
> PR deployment will be re-deployed automatically when the PR is updated.
146145
> It will use the last values automatically for redeployment.
147146
148147
Once the deployment is finished, a unique link and credentials will be posted in
@@ -256,8 +255,7 @@ Our frontend guide can be found [here](./contributing/frontend.md).
256255

257256
## Reviews
258257

259-
> The following information has been borrowed from
260-
> [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).
261259

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

346344
### Security
347345

346+
> [!CAUTION]
348347
> If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
349348
> to <[email protected]>.
350349

‎docs/admin/external-auth.md

+13-24
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

@@ -120,11 +121,8 @@ The Redirect URI for Gitea should be
120121

121122
### GitHub
122123

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>
124+
> [!TIP]
125+
> If you don't require fine-grained access control, it's easier to [configure a GitHub OAuth app](#configure-a-github-oauth-app).
128126
129127
```env
130128
CODER_EXTERNAL_AUTH_0_ID="USER_DEFINED_ID"
@@ -179,7 +177,8 @@ CODER_EXTERNAL_AUTH_0_VALIDATE_URL="https://your-domain.com/oauth/token/info"
179177
CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
180178
```
181179

182-
> 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.
183182
184183
## Custom scopes
185184

@@ -222,26 +221,16 @@ CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
222221

223222
![Install GitHub App](../images/admin/github-app-install.png)
224223

225-
## Multiple External Providers
226-
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+
## Multiple External Providers (Enterprise)(Premium)
233225

234226
Below is an example configuration with multiple providers:
235227

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>
228+
> [!IMPORTANT]
229+
> 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):
230+
>
231+
> ```shell
232+
> git config --global credential.useHttpPath true
233+
> ```
245234
246235
```env
247236
# Provider 1) github.com

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

+12-14
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,25 @@ 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

3536
Since Coder's performance is highly dependent on the templates and workflows you
3637
support, you may wish to use our internal scale testing utility against your own
3738
environments.
3839

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>
40+
> [!IMPORTANT]
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.
5250
5351
### Create workspaces
5452

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

+2-3
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/jfrog-artifactory.md

+2-5
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

+5-8
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/integrations/opentofu.md

+4-4
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

+1-2
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

+16-31
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

@@ -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/logs.md

+2-1
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/monitoring/notifications/index.md

+3-6
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/monitoring/notifications/slack.md

+4-5
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.

0 commit comments

Comments
 (0)