8000 docs: remove nested alerts (#18580) · coder/coder@072c81c · GitHub
[go: up one dir, main page]

Skip to content

Commit 072c81c

Browse files
authored
docs: remove nested alerts (#18580)
hotfix removes nested gfm alerts, which is a known ~issue~ feature https://github.com/orgs/community/discussions/16925#discussioncomment-12043928 Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 3c4d920 commit 072c81c

File tree

7 files changed

+23
-36
lines changed

7 files changed

+23
-36
lines changed

docs/admin/security/database-encryption.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,10 @@ data:
118118
This command will re-encrypt all tokens with the specified new encryption key.
119119
We recommend performing this action during a maintenance window.
120120

121-
> [!IMPORTANT]
122-
> This command requires direct access to the database. If you are using
123-
> the built-in PostgreSQL database, you can run
124-
> [`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md)
125-
> to get the connection URL.
121+
This command requires direct access to the database.
122+
If you are using the built-in PostgreSQL database, you can run
123+
[`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md)
124+
to get the connection URL.
126125

127126
- Once the above command completes successfully, remove the old encryption key
128127
from Coder's configuration and restart Coder once more. You can now safely

docs/admin/templates/creating-templates.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +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]
29-
> If template creation fails, Coder is likely not authorized to
30-
> deploy infrastructure in the given location. Learn how to configure
31-
> [provisioner authentication](./extending-templates/provider-authentication.md).
28+
If template creation fails, it's likely that Coder is not authorized to deploy infrastructure in the given location.
29+
Learn how to configure [provisioner authentication](./extending-templates/provider-authentication.md).
3230

3331
### CLI
3432

@@ -65,10 +63,8 @@ Next, push it to Coder with the
6563
coder templates push
6664
```
6765

68-
> [!NOTE]
69-
> If `template push` fails, Coder is likely not authorized to deploy
70-
> infrastructure in the given location. Learn how to configure
71-
> [provisioner authentication](../provisioners/index.md).
66+
If `template push` fails, it's likely that Coder is not authorized to deploy infrastructure in the given location.
67+
Learn how to configure [provisioner authentication](../provisioners/index.md).
7268

7369
You can edit the metadata of the template such as the display name with the
7470
[`templates edit`](../../reference/cli/templates_edit.md) command:

docs/admin/users/idp-sync.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,9 @@ Below is an example that uses the `groups` claim and maps all groups prefixed by
107107
}
108108
```
109109

110-
> [!IMPORTANT]
111-
> You must specify Coder group IDs instead of group names. The fastest way to find
112-
> the ID for a corresponding group is by visiting
113-
> `https://coder.example.com/api/v2/groups`.
110+
You must specify Coder group IDs instead of group names.
111+
You can find the ID for a corresponding group by visiting
112+
`https://coder.example.com/api/v2/groups`.
114113

115114
Here is another example which maps `coder-admins` from the identity provider to
116115
two groups in Coder and `coder-users` from the identity provider to another

docs/install/cli.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ alternate installation methods (e.g. standalone binaries, system packages).
2222

2323
## Windows
2424

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

3129
Use [GitHub releases](https://github.com/coder/coder/releases) to download the
3230
Windows installer (`.msi`) or standalone binary (`.exe`).

docs/install/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,9 @@ alternate installation methods (e.g. standalone binaries, system packages).
2929

3030
## Windows
3131

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

3836
Use [GitHub releases](https://github.com/coder/coder/releases) to download the
3937
Windows installer (`.msi`) or standalone binary (`.exe`).

docs/start/local-deploy.md

Original file line numberDiff line numberDiff line change
@@ -29,11 +29,9 @@ curl -L https://coder.com/install.sh | sh
2929

3030
## Windows
3131

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

3836
You can use the
3937
[`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget)

docs/tutorials/quickstart.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,9 @@ persistent environment from your main device, a tablet, or your phone.
5757

5858
## Windows
5959

60-
> [!IMPORTANT]
61-
> If you plan to use the built-in PostgreSQL database, ensure that the
62-
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
63-
> is installed.
60+
If you plan to use the built-in PostgreSQL database, ensure that the
61+
[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
62+
is installed.
6463

6564
1. [Install Docker](https://docs.docker.com/desktop/install/windows-install/).
6665

0 commit comments

Comments
 (0)
0