From 72b8ab530ef2a757f98767b33719ec5dc33df2f4 Mon Sep 17 00:00:00 2001 From: Andrew Aquino Date: Mon, 28 Jul 2025 18:00:56 -0400 Subject: [PATCH] fix(docs): add missing GFM alert directives to blockquotes (#19042) I just added support for rendering GFM alerts inside of numbered lists in coder.com (see https://github.com/coder/coder.com/pull/328), and noticed that these plain blockquotes should probably be alerts. This should cover all the missing alerts. I found them by searching for the regex `^\s*>\s` within docs/**/*.md Is `[!NOTE]` the correct type for these? Or do we want to use tip/important/etc? - @mtojek CONTRIBUTING.md - @johnstcn support-bundle.md - @matifali gateway.md --- docs/about/contributing/CONTRIBUTING.md | 1 + docs/support/support-bundle.md | 1 + docs/user-guides/workspace-access/jetbrains/gateway.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/about/contributing/CONTRIBUTING.md b/docs/about/contributing/CONTRIBUTING.md index 8f4eb518ba..7eedebb146 100644 --- a/docs/about/contributing/CONTRIBUTING.md +++ b/docs/about/contributing/CONTRIBUTING.md @@ -96,6 +96,7 @@ Use the following `make` commands and scripts in development: This should return an empty list of workspaces. If you encounter an error, review the output from the [develop.sh](https://github.com/coder/coder/blob/main/scripts/develop.sh) script for issues. + > [!NOTE] > `coder-dev.sh` is a helper script that behaves like the regular coder CLI, but uses the binary built from your local source and shares the same configuration directory set up by `develop.sh`. This ensures your local changes are reflected when testing. > > The default user is `admin@coder.com` and the default password is `SomeSecurePassword!` diff --git a/docs/support/support-bundle.md b/docs/support/support-bundle.md index 7cac0058f4..1741dbfb66 100644 --- a/docs/support/support-bundle.md +++ b/docs/support/support-bundle.md @@ -73,6 +73,7 @@ A brief overview of all files contained in the bundle is provided below: prompt. The support bundle will be generated in the current directory with the filename `coder-support-$TIMESTAMP.zip`. + > [!NOTE] > While support bundles can be generated without a running workspace, it is > recommended to specify one to maximize troubleshooting information. diff --git a/docs/user-guides/workspace-access/jetbrains/gateway.md b/docs/user-guides/workspace-access/jetbrains/gateway.md index 09c54a10e8..b7065b56a0 100644 --- a/docs/user-guides/workspace-access/jetbrains/gateway.md +++ b/docs/user-guides/workspace-access/jetbrains/gateway.md @@ -10,6 +10,7 @@ manually configured SSH connection. ### How to use the plugin +> [!NOTE] > If you experience problems, please > [create a GitHub issue](https://github.com/coder/coder/issues) or share in > [our Discord channel](https://discord.gg/coder).