opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 05:05:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: uppercase mixed-case GitHub-style callout markers [DOCS-681] (#28304)

Browse Source 
## What

Uppercase the mixed-case GitHub-style callout markers in the docs corpus
to the canonical all-caps form.

- `docs/install/rancher.md`: `> [!Important]` -> `> [!IMPORTANT]`
- `docs/user-guides/shared-workspaces.md`: `> [!Important]` -> `>
[!IMPORTANT]`
- `docs/user-guides/workspace-access/index.md`: `> [!Note]` -> `>
[!NOTE]`

A full-corpus scan confirmed these were the only mixed-case markers.

## Why

GitHub alerts, the hosted docs (coder.com), and the offlinedocs Fumadocs
renderer all require all-caps alert types (`[!NOTE]`, `[!IMPORTANT]`,
and so on). The mixed-case form rendered as literal text instead of a
styled alert (on some pages directly next to a correctly-rendered
all-caps alert), so this is a genuine rendering fix on GitHub and
coder.com, not an offline-pipeline accommodation.

Surfaced by the offlinedocs Fumadocs migration review (CRF-60 on
#27390). Tracked separately from the space-after-`!` fix (DOCS-680), per
request.

Linear:
[DOCS-681](https://linear.app/codercom/issue/DOCS-681/uppercase-mixed-case-github-style-callout-markers-across-docs)

> This PR was created with AI assistance (Coder Agents).
This commit is contained in:
Nick Vigilante
2026-08-19 11:48:32 -04:00
committed by GitHub
parent 023f61626d
commit 2ee6f459b2
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/install/rancher.md
+1 -1
View File
@@ -83,7 +83,7 @@ kubectl create secret generic coder-db-url -n coder \
--from-literal=url="postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable"
```
> [!Important]
> [!IMPORTANT]
> If you're using a managed PostgreSQL service, replace the connection URL with your specific database credentials.
## Install Coder through the Rancher UI
docs/user-guides/shared-workspaces.md
+1 -1
View File
@@ -40,7 +40,7 @@ To remove sharing from a workspace:
- `coder sharing remove <workspace> --group contractor`
- Workspace is no longer shared with the group `contractor`.
> [!Important]
> [!IMPORTANT]
> The workspace must be restarted for the user or group removal to take effect.
To show who a workspace is shared with:
docs/user-guides/workspace-access/index.md
+1 -1
View File
@@ -38,7 +38,7 @@ coder ssh my-workspace
Or, you can configure plain SSH on your client below.
> [!Note]
> [!NOTE]
> The `coder ssh` command does not have full parity with the standard
> SSH command. For users who need the full functionality of SSH, use the
> configuration method below.