Skip to content

Commit 06c8b36

Browse files
EdwardAngertEdwardAngert
committed
edit or remove non GFM blockquote alerts
1 parent 6b4d36a commit 06c8b36

38 files changed

+169
-146
lines changed

‎docs/admin/templates/creating-templates.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Give your template a name, description, and icon and press `Create template`.
2525

2626
![Name and icon](../../images/admin/templates/import-template.png)
2727

28-
> **⚠️ Note**: If template creation fails, Coder is likely not authorized to
28+
> [!NOTE]
29+
> If template creation fails, Coder is likely not authorized to
2930
> deploy infrastructure in the given location. Learn how to configure
3031
> [provisioner authentication](./extending-templates/provider-authentication.md).
3132
@@ -64,7 +65,8 @@ Next, push it to Coder with the
6465
coder templates push
6566
```
6667

67-
> ⚠️ Note: If `template push` fails, Coder is likely not authorized to deploy
68+
> [!NOTE]
69+
> If `template push` fails, Coder is likely not authorized to deploy
6870
> infrastructure in the given location. Learn how to configure
6971
> [provisioner authentication](../provisioners.md).
7072

‎docs/admin/templates/extending-templates/docker-in-workspaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,8 +273,8 @@ A
273273
can be added to your templates to add docker support. This may come in handy if
274274
your nodes cannot run Sysbox.
275275
276-
> ⚠️ **Warning**: This is insecure. Workspaces will be able to gain root access
277-
> to the host machine.
276+
> [!WARNING]
277+
> This is insecure. Workspaces will be able to gain root access to the host machine.
278278
279279
### Use a privileged sidecar container in Docker-based templates
280280

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
9393
}
9494
```
9595

96-
6. Update module source as,
96+
6. Update module source as:
9797

9898
```tf
9999
module "module-name" {
@@ -104,7 +104,7 @@ to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
104104
}
105105
```
106106

107-
> Do not forget to replace example.jfrog.io with your Artifactory URL
107+
Replace `example.jfrog.io` with your Artifactory URL
108108

109109
Based on the instructions
110110
[here](https://jfrog.com/blog/tour-terraform-registries-in-artifactory/).

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

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

6+
This feature is only available on Linux in Kubernetes. There are
7+
additional requirements outlined further in this document.
8+
69
> [!NOTE]
7-
> This feature is only available on Linux in Kubernetes. There are
8-
> additional requirements outlined further in this document.
10+
> Workspace process logging is an Enterprise and Premium feature.
11+
> [Learn more](https://coder.com/pricing#compare-plans).
912
1013
Workspace process logging adds a sidecar container to workspace pods that will
1114
log all processes started in the workspace container (e.g., commands executed in
@@ -17,10 +20,6 @@ monitoring stack, such as CloudWatch, for further analysis or long-term storage.
1720
Please note that these logs are not recorded or captured by the Coder
1821
organization in any way, shape, or form.
1922

20-
> This is an [Premium or Enterprise](https://coder.com/pricing) feature. To
21-
> learn more about Coder licensing, please
22-
> [contact sales](https://coder.com/contact).
23-
2423
## How this works
2524

2625
Coder uses [eBPF](https://ebpf.io/) (which we chose for its minimal performance

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ to consider:
3131
`docker`, `bash`, `jq`, and/or internal tooling
3232
- Consider creating (and starting the container with) a non-root user
3333

34-
> See Coder's
35-
> [example base image](https://github.com/coder/enterprise-images/tree/main/images/minimal)
36-
> for reference.
34+
See Coder's
35+
[example base image](https://github.com/coder/enterprise-images/tree/main/images/minimal)
36+
for reference.
3737

3838
## Create general-purpose golden image(s) with standard tooling
3939

@@ -54,10 +54,10 @@ purpose images are great for:
5454
stacks and types of projects, the golden image can be a good starting point
5555
for those projects.
5656

57-
> This is often referred to as a "sandbox" or "kitchen sink" image. Since large
58-
> multi-purpose container images can quickly become difficult to maintain, it's
59-
> important to keep the number of general-purpose images to a minimum (2-3 in
60-
> most cases) with a well-defined scope.
57+
This is often referred to as a "sandbox" or "kitchen sink" image. Since large
58+
multi-purpose container images can quickly become difficult to maintain, it's
59+
important to keep the number of general-purpose images to a minimum (2-3 in
60+
most cases) with a well-defined scope.
6161

6262
Examples:
6363

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ here!
2727
If you prefer to use Coder on the
2828
[command line](../../../reference/cli/index.md), `coder templates init`.
2929

30-
> Coder starter templates are also available on our
31-
> [GitHub repo](https://github.com/coder/coder/tree/main/examples/templates).
30+
Coder starter templates are also available on our
31+
[GitHub repo](https://github.com/coder/coder/tree/main/examples/templates).
3232

3333
## Community Templates
3434

@@ -46,6 +46,7 @@ any template's files directly in the Coder dashboard.
4646
If you'd prefer to use the CLI, use `coder templates pull`, edit the template
4747
files, then `coder templates push`.
4848

49+
> [!TIP]
4950
> Even if you are a Terraform expert, we suggest reading our
5051
> [guided tour of a template](../../../tutorials/template-from-scratch.md).
5152

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ To upgrade Coder, run:
116116
helm upgrade <release-name> coder-v2/coder -n <namespace> -f values.yaml
117117
```
118118

119-
> We recommend requiring and auditing MFA usage for all users in your GitHub
120-
> organizations. This can be enforced from the organization settings page in the
121-
> "Authentication security" sidebar tab.
119+
We recommend requiring and auditing MFA usage for all users in your GitHub
120+
organizations. This can be enforced from the organization settings page in the
121+
"Authentication security" sidebar tab.
122122

123123
## Device Flow
124124

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Headless user accounts that cannot use the web UI to log in to Coder. This is
44
useful for creating accounts for automated systems, such as CI/CD pipelines or
55
for users who only consume Coder via another client/API.
66

7-
> You must have the User Admin role or above to create headless users.
7+
You must have the User Admin role or above to create headless users.
88

99
## Create a headless user
1010

‎docs/admin/users/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ You can also reset a password via the CLI:
166166
coder reset-password <username>
167167
```
168168

169+
> [!NOTE]
169170
> Resetting a user's password, e.g., the initial `owner` role-based user, only
170171
> works when run on the host running the Coder control plane.
171172

‎docs/changelogs/v0.25.0.md

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

3-
> **Warning**: This release has a known issue: #8351. Upgrade directly to
3+
> [!WARNING]
4+
> This release has a known issue: #8351. Upgrade directly to
45
> v0.26.0 which includes a fix
56
67
### Features

‎docs/changelogs/v0.27.0.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
Agent logs can be pushed after a workspace has started (#8528)
66

7-
> ⚠️ **Warning:** You will need to
7+
> [!WARNING]
8+
> You will need to
89
> [update](https://coder.com/docs/install) your local Coder CLI v0.27
910
> to connect via `coder ssh`.
1011

‎docs/contributing/frontend.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ views, tests, and utility functions. The page component fetches necessary data
8585
and passes to the view. We explain this decision a bit better in the next
8686
section which talks about where to fetch data.
8787

88-
> ℹ️ If code within a page becomes reusable across other parts of the app,
89-
> consider moving it to `src/utils`, `hooks`, `components`, or `modules`.
88+
If code within a page becomes reusable across other parts of the app,
89+
consider moving it to `src/utils`, `hooks`, `components`, or `modules`.
9090

9191
### Handling States
9292

@@ -269,8 +269,8 @@ template", etc. We use [Playwright](https://playwright.dev/). If you only need
269269
to test if the page is being rendered correctly, you should consider using the
270270
**Visual Testing** approach.
271271

272-
> ℹ️ For scenarios where you need to be authenticated, you can use
273-
> `test.use({ storageState: getStatePath("authState") })`.
272+
For scenarios where you need to be authenticated, you can use
273+
`test.use({ storageState: getStatePath("authState") })`.
274274

275275
For ease of debugging, it's possible to run a Playwright test in headful mode
276276
running a Playwright server on your local machine, and executing the test inside
@@ -306,8 +306,8 @@ always be your first option since it is way easier to maintain. For this, we use
306306
[Storybook](https://storybook.js.org/) and
307307
[Chromatic](https://www.chromatic.com/).
308308

309-
> ℹ️ To learn more about testing components that fetch API data, refer to the
310-
> [**Where to fetch data**](#where-to-fetch-data) section.
309+
To learn more about testing components that fetch API data, refer to the
310+
[**Where to fetch data**](#where-to-fetch-data) section.
311311

312312
### What should I test?
313313

‎docs/install/cli.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ alternate installation methods (e.g. standalone binaries, system packages).
2222

2323
## Windows
2424

25-
> **Important:** If you plan to use the built-in PostgreSQL database, you will
25+
> [!IMPORTANT]
26+
> If you plan to use the built-in PostgreSQL database, you will
2627
> need to ensure that the
2728
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
2829
> is installed.

‎docs/install/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ alternate installation methods (e.g. standalone binaries, system packages).
2929

3030
## Windows
3131

32-
> **Important:** If you plan to use the built-in PostgreSQL database, you will
32+
> [!IMPORTANT]
33+
> If you plan to use the built-in PostgreSQL database, you will
3334
> need to ensure that the
3435
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
3536
> is installed.

‎docs/install/kubernetes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,11 @@ coder:
116116
# - my-tls-secret-name
117117
```
118118

119-
> You can view our
120-
> [Helm README](https://github.com/coder/coder/blob/main/helm#readme) for
121-
> details on the values that are available, or you can view the
122-
> [values.yaml](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
123-
> file directly.
119+
You can view our
120+
[Helm README](https://github.com/coder/coder/blob/main/helm#readme) for
121+
details on the values that are available, or you can view the
122+
[values.yaml](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
123+
file directly.
124124

125125
We support two release channels: mainline and stable - read the
126126
[Releases](./releases.md) page to learn more about which best suits your team.

‎docs/install/offline.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
All Coder features are supported in offline / behind firewalls / in air-gapped
44
environments. However, some changes to your configuration are necessary.
55

6-
> This is a general comparison. Keep reading for a full tutorial running Coder
7-
> offline with Kubernetes or Docker.
6+
This is a general comparison. Keep reading for a full tutorial running Coder
7+
offline with Kubernetes or Docker.
88

99
| | Public deployments | Offline deployments |
1010
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -113,6 +113,7 @@ USER coder
113113
ENV TF_CLI_CONFIG_FILE=/home/coder/.terraformrc
114114
```
115115

116+
> [!NOTE]
116117
> If you are bundling Terraform providers into your Coder image, be sure the
117118
> provider version matches any templates or
118119
> [example templates](https://github.com/coder/coder/tree/main/examples/templates)
@@ -175,10 +176,10 @@ services:
175176
# ...
176177
```
177178

178-
> The
179-
> [terraform providers mirror](https://www.terraform.io/cli/commands/providers/mirror)
180-
> command can be used to download the required plugins for a Coder template.
181-
> This can be uploaded into the `plugins` directory on your offline server.
179+
The
180+
[terraform providers mirror](https://www.terraform.io/cli/commands/providers/mirror)
181+
command can be used to download the required plugins for a Coder template.
182+
This can be uploaded into the `plugins` directory on your offline server.
182183

183184
### Kubernetes
184185

‎docs/install/releases.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ only for security issues or CVEs.
3434

3535
- In-product security vulnerabilities and CVEs are supported
3636

37-
> For more information on feature rollout, see our
38-
> [feature stages documentation](../about/feature-stages.md).
37+
For more information on feature rollout, see our
38+
[feature stages documentation](../about/feature-stages.md).
3939

4040
## Installing stable
4141

@@ -66,7 +66,8 @@ pages.
6666
| 2.19.x | February 04, 2024 | Stable |
6767
| 2.20.x | March 05, 2024 | Mainline |
6868

69-
> **Tip**: We publish a
69+
> [!TIP]
70+
> We publish a
7071
> [`preview`](https://github.com/coder/coder/pkgs/container/coder-preview) image
7172
> `ghcr.io/coder/coder-preview` on each commit to the `main` branch. This can be
7273
> used to test under-development features and bug fixes that have not yet been

‎docs/install/uninstall.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ sudo rm /etc/coder.d/coder.env
6868

6969
## Coder settings, cache, and the optional built-in PostgreSQL database
7070

71-
> There is a `postgres` directory within the `coderv2` directory that has the
72-
> database engine and database. If you want to reuse the database, consider not
73-
> performing the following step or copying the directory to another location.
71+
There is a `postgres` directory within the `coderv2` directory that has the
72+
database engine and database. If you want to reuse the database, consider not
73+
performing the following step or copying the directory to another location.
7474

7575
<div class="tabs">
7676

‎docs/start/first-template.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Containers** template by pressing **Use Template**.
2828

2929
![Starter Templates UI](../images/start/starter-templates.png)
3030

31-
> You can also a find a comprehensive list of starter templates in **Templates**
32-
> -> **Create Template** -> **Starter Templates**. s
31+
You can also a find a comprehensive list of starter templates in **Templates**
32+
-> **Create Template** -> **Starter Templates**. s
3333

3434
## 3. Create your template
3535

@@ -75,7 +75,8 @@ This starter template lets you connect to your workspace in a few ways:
7575
haven't already, you'll have to install Coder on your local machine to
7676
configure your SSH client.
7777
78-
> **Tip**: You can edit the template to let developers connect to a workspace in
78+
> [!TIP]
79+
> You can edit the template to let developers connect to a workspace in
7980
> [a few more ways](../ides.md).
8081
8182
When you're done, you can stop the workspace. -->

‎docs/start/first-workspace.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ The Docker starter template lets you connect to your workspace in a few ways:
5050
haven't already, you'll have to install Coder on your local machine to
5151
configure your SSH client.
5252

53-
> **Tip**: You can edit the template to let developers connect to a workspace in
53+
> [!TIP]
54+
> You can edit the template to let developers connect to a workspace in
5455
> [a few more ways](../admin/templates/extending-templates/web-ides.md).
5556
5657
## 3. Modify your workspace settings

‎docs/start/local-deploy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ simplicity.
1515

1616
First, install [Docker](https://docs.docker.com/engine/install/) locally.
1717

18-
> If you already have the Coder binary installed, restart it after installing
19-
> Docker.
18+
If you already have the Coder binary installed, restart it after installing Docker.
2019

2120
<div class="tabs">
2221

@@ -30,7 +29,8 @@ curl -L https://coder.com/install.sh | sh
3029

3130
## Windows
3231

33-
> **Important:** If you plan to use the built-in PostgreSQL database, you will
32+
> [!IMPORTANT]
33+
> If you plan to use the built-in PostgreSQL database, you will
3434
> need to ensure that the
3535
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
3636
> is installed.

‎docs/tutorials/cloning-git-repositories.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ module "git-clone" {
3939
}
4040
```
4141

42-
> You can edit the template using an IDE or terminal of your preference, or by
43-
> going into the
44-
> [template editor UI](../admin/templates/creating-templates.md#web-ui).
42+
You can edit the template using an IDE or terminal of your preference, or by
43+
going into the
44+
[template editor UI](../admin/templates/creating-templates.md#web-ui).
4545

4646
You can also use
4747
[template parameters](../admin/templates/extending-templates/parameters.md) to
@@ -63,9 +63,9 @@ module "git-clone" {
6363
}
6464
```
6565

66-
> If you need more customization, you can read the
67-
> [Git Clone module](https://registry.coder.com/modules/git-clone) documentation
68-
> to learn more about the module.
66+
If you need more customization, you can read the
67+
[Git Clone module](https://registry.coder.com/modules/git-clone) documentation
68+
to learn more about the module.
6969

7070
Don't forget to build and publish the template changes before creating a new
7171
workspace. You can check if the repository is cloned by accessing the workspace

0 commit comments

Comments
 (0)