Skip to content

Commit 72b8ab5

Browse files
authored
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 coder/coder.com#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
1 parent 36d2e01 commit 72b8ab5

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

docs/about/contributing/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ Use the following `make` commands and scripts in development:
9696

9797
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.
9898

99+
> [!NOTE]
99100
> `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.
100101
>
101102
> The default user is `admin@coder.com` and the default password is `SomeSecurePassword!`

docs/support/support-bundle.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ A brief overview of all files contained in the bundle is provided below:
7373
prompt. The support bundle will be generated in the current directory with
7474
the filename `coder-support-$TIMESTAMP.zip`.
7575

76+
> [!NOTE]
7677
> While support bundles can be generated without a running workspace, it is
7778
> recommended to specify one to maximize troubleshooting information.
7879

docs/user-guides/workspace-access/jetbrains/gateway.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ manually configured SSH connection.
1010

1111
### How to use the plugin
1212

13+
> [!NOTE]
1314
> If you experience problems, please
1415
> [create a GitHub issue](https://github.com/coder/coder/issues) or share in
1516
> [our Discord channel](https://discord.gg/coder).

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy