diff --git a/docs/admin/security/database-encryption.md b/docs/admin/security/database-encryption.md index 289c18a7c1..ecdea90dba 100644 --- a/docs/admin/security/database-encryption.md +++ b/docs/admin/security/database-encryption.md @@ -118,11 +118,10 @@ data: This command will re-encrypt all tokens with the specified new encryption key. We recommend performing this action during a maintenance window. - > [!IMPORTANT] - > This command requires direct access to the database. If you are using - > the built-in PostgreSQL database, you can run - > [`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md) - > to get the connection URL. + This command requires direct access to the database. + If you are using the built-in PostgreSQL database, you can run + [`coder server postgres-builtin-url`](../../reference/cli/server_postgres-builtin-url.md) + to get the connection URL. - Once the above command completes successfully, remove the old encryption key from Coder's configuration and restart Coder once more. You can now safely diff --git a/docs/admin/templates/creating-templates.md b/docs/admin/templates/creating-templates.md index a0a6b54366..6387cc0368 100644 --- a/docs/admin/templates/creating-templates.md +++ b/docs/admin/templates/creating-templates.md @@ -25,10 +25,8 @@ Give your template a name, description, and icon and press `Create template`. ![Name and icon](../../images/admin/templates/import-template.png) -> [!NOTE] -> If template creation fails, Coder is likely not authorized to -> deploy infrastructure in the given location. Learn how to configure -> [provisioner authentication](./extending-templates/provider-authentication.md). +If template creation fails, it's likely that Coder is not authorized to deploy infrastructure in the given location. +Learn how to configure [provisioner authentication](./extending-templates/provider-authentication.md). ### CLI @@ -65,10 +63,8 @@ Next, push it to Coder with the coder templates push ``` -> [!NOTE] -> If `template push` fails, Coder is likely not authorized to deploy -> infrastructure in the given location. Learn how to configure -> [provisioner authentication](../provisioners/index.md). +If `template push` fails, it's likely that Coder is not authorized to deploy infrastructure in the given location. +Learn how to configure [provisioner authentication](../provisioners/index.md). You can edit the metadata of the template such as the display name with the [`templates edit`](../../reference/cli/templates_edit.md) command: diff --git a/docs/admin/users/idp-sync.md b/docs/admin/users/idp-sync.md index b59431c5f0..e893bf91bb 100644 --- a/docs/admin/users/idp-sync.md +++ b/docs/admin/users/idp-sync.md @@ -107,10 +107,9 @@ Below is an example that uses the `groups` claim and maps all groups prefixed by } ``` -> [!IMPORTANT] -> You must specify Coder group IDs instead of group names. The fastest way to find -> the ID for a corresponding group is by visiting -> `https://coder.example.com/api/v2/groups`. +You must specify Coder group IDs instead of group names. +You can find the ID for a corresponding group by visiting +`https://coder.example.com/api/v2/groups`. Here is another example which maps `coder-admins` from the identity provider to two groups in Coder and `coder-users` from the identity provider to another diff --git a/docs/install/cli.md b/docs/install/cli.md index 9ee914a80f..9193c9a103 100644 --- a/docs/install/cli.md +++ b/docs/install/cli.md @@ -22,11 +22,9 @@ alternate installation methods (e.g. standalone binaries, system packages). ## Windows -> [!IMPORTANT] -> If you plan to use the built-in PostgreSQL database, you will -> need to ensure that the -> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) -> is installed. +If you plan to use the built-in PostgreSQL database, ensure that the +[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) +is installed. Use [GitHub releases](https://github.com/coder/coder/releases) to download the Windows installer (`.msi`) or standalone binary (`.exe`). diff --git a/docs/install/index.md b/docs/install/index.md index ae64dd2bf5..c1d12dd779 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -29,11 +29,9 @@ alternate installation methods (e.g. standalone binaries, system packages). ## Windows -> [!IMPORTANT] -> If you plan to use the built-in PostgreSQL database, you will -> need to ensure that the -> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) -> is installed. +If you plan to use the built-in PostgreSQL database, ensure that the +[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) +is installed. Use [GitHub releases](https://github.com/coder/coder/releases) to download the Windows installer (`.msi`) or standalone binary (`.exe`). diff --git a/docs/start/local-deploy.md b/docs/start/local-deploy.md index 3fe501c02b..eb3b2af131 100644 --- a/docs/start/local-deploy.md +++ b/docs/start/local-deploy.md @@ -29,11 +29,9 @@ curl -L https://coder.com/install.sh | sh ## Windows -> [!IMPORTANT] -> If you plan to use the built-in PostgreSQL database, you will -> need to ensure that the -> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) -> is installed. +If you plan to use the built-in PostgreSQL database, ensure that the +[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) +is installed. You can use the [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/winget/#use-winget) diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md index a09bb95d47..595414fd63 100644 --- a/docs/tutorials/quickstart.md +++ b/docs/tutorials/quickstart.md @@ -57,10 +57,9 @@ persistent environment from your main device, a tablet, or your phone. ## Windows -> [!IMPORTANT] -> If you plan to use the built-in PostgreSQL database, ensure that the -> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) -> is installed. +If you plan to use the built-in PostgreSQL database, ensure that the +[Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version) +is installed. 1. [Install Docker](https://docs.docker.com/desktop/install/windows-install/).