Skip to content

docs: markdown fixes and edits #15527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 3, 2025
Merged

docs: markdown fixes and edits #15527

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
cbcde57
docs: improve admonition for need to add useHttpPath
angrycub Nov 14, 2024
2145ffa
docs: fix list item nesting
angrycub Nov 14, 2024
004ab1a
docs: fix list item nesting
angrycub Nov 14, 2024
aea6967
docs: improve admonition for authentication
angrycub Nov 14, 2024
dfbe02b
docs: tidy and update vault guide
angrycub Nov 14, 2024
8db635c
docs: improve admonitions
angrycub Nov 14, 2024
93b6a5b
docs: improve admonitions
angrycub Nov 14, 2024
504d426
docs: content edits, reference links to make copy easier to read
angrycub Nov 14, 2024
63c5136
make fmt
EdwardAngert Nov 18, 2024
c6d7b3b
Merge remote-tracking branch 'origin/main' into fix-guides-list-numbers
EdwardAngert Jan 3, 2025
b5b2e91
use new linter
EdwardAngert Jan 3, 2025
f059ab3
fix links
EdwardAngert Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: improve admonitions
  • Loading branch information
@angrycub
angrycub committed Nov 14, 2024
commit 8db635c2174eefd69864bb4b053f6cddee12833d
44 changes: 28 additions & 16 deletions docs/admin/monitoring/health-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,14 @@ Coder's current activity and usage. It may be necessary to increase the
resources allocated to Coder's database. Alternatively, you can raise the
configured threshold to a higher value (this will not address the root cause).

> [!TIP]
>
> - You can enable
> [detailed database metrics](../../reference/cli/server.md#--prometheus-collect-db-metrics)
> in Coder's Prometheus endpoint.
> - If you have [tracing enabled](../../reference/cli/server.md#--trace), these
> traces may also contain useful information regarding Coder's database
> activity.
<blockquote class="admonition tip">

You can enable
[detailed database metrics](../../reference/cli/server.md#--prometheus-collect-db-metrics)
in Coder's Prometheus endpoint.
If you have [tracing enabled](../../reference/cli/server.md#--trace), these
traces may also contain useful information regarding Coder's database activity.
</blockquote>

## DERP

Expand All @@ -149,8 +149,11 @@ This is not necessarily a fatal error, but a possible indication of a
misconfigured reverse HTTP proxy. Additionally, while workspace users should
still be able to reach their workspaces, connection performance may be degraded.

> **Note:** This may also be shown if you have
> [forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
<blockquote class="admonition note">

**Note:** This may also be shown if you have
[forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
</blockquote>

**Solution:** ensure that any proxies you use allow connection upgrade with the
`Upgrade: derp` header.
Expand Down Expand Up @@ -300,8 +303,11 @@ that they are able to successfully connect to Coder. Otherwise, ensure
[`--provisioner-daemons`](../../reference/cli/server.md#--provisioner-daemons)
is set to a value greater than 0.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.
<blockquote class="admonition note">

**Note:** This may be a transient issue if you are currently in the process of
updating your deployment.
</blockquote>

### EPD02

Expand All @@ -315,8 +321,11 @@ of API incompatibility.
**Solution:** Update the provisioner daemon to match the currently running
version of Coder.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.
<blockquote class="admonition note">

**Note:** This may be a transient issue if you are currently in the process of
updating your deployment.
</blockquote>

### EPD03

Expand All @@ -330,8 +339,11 @@ connect to Coder.
**Solution:** Update the provisioner daemon to match the currently running
version of Coder.

> Note: This may be a transient issue if you are currently in the process of
> updating your deployment.
<blockquote class="admonition note">

**Note:** This may be a transient issue if you are currently in the process of
updating your deployment.
</blockquote>

## EUNKNOWN

Expand Down