mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: convert alerts to use GitHub Flavored Markdown (GFM) (#16850)
followup to #16761 thanks @lucasmelin ! + thanks: @ethanndickson @Parkreiner @matifali @aqandrew - [x] update snippet - [x] find/replace - [x] spot-check [preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule) (and others) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: M Atif Ali <atif@coder.com>
This commit is contained in:
co-authored by
EdwardAngert
M Atif Ali
parent
e817713dc0
commit
101b62dc3e
@@ -40,7 +40,7 @@ If there is an issue, you may see one of the following errors reported:
|
||||
[`url.Parse`](https://pkg.go.dev/net/url#Parse). Example:
|
||||
`https://dev.coder.com/`.
|
||||
|
||||
> **Tip:** You can check this [here](https://go.dev/play/p/CabcJZyTwt9).
|
||||
You can use [the Go playground](https://go.dev/play/p/CabcJZyTwt9) for additional testing.
|
||||
|
||||
### EACS03
|
||||
|
||||
@@ -117,15 +117,12 @@ 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).
|
||||
|
||||
<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>
|
||||
> [!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.
|
||||
|
||||
## DERP
|
||||
|
||||
@@ -150,12 +147,9 @@ 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.
|
||||
|
||||
<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>
|
||||
> [!NOTE]
|
||||
> This may also be shown if you have
|
||||
> [forced websocket connections for DERP](../../reference/cli/server.md#--derp-force-websockets).
|
||||
|
||||
**Solution:** ensure that any proxies you use allow connection upgrade with the
|
||||
`Upgrade: derp` header.
|
||||
@@ -305,13 +299,10 @@ 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.
|
||||
|
||||
<blockquote class="admonition note">
|
||||
|
||||
**Note:** This may be a transient issue if you are currently in the process of
|
||||
> [!NOTE]
|
||||
> This may be a transient issue if you are currently in the process of
|
||||
updating your deployment.
|
||||
|
||||
</blockquote>
|
||||
|
||||
### EPD02
|
||||
|
||||
#### Provisioner Daemon Version Mismatch
|
||||
@@ -324,13 +315,10 @@ of API incompatibility.
|
||||
**Solution:** Update the provisioner daemon to match the currently running
|
||||
version of Coder.
|
||||
|
||||
<blockquote class="admonition note">
|
||||
|
||||
**Note:** This may be a transient issue if you are currently in the process of
|
||||
> [!NOTE]
|
||||
> This may be a transient issue if you are currently in the process of
|
||||
updating your deployment.
|
||||
|
||||
</blockquote>
|
||||
|
||||
### EPD03
|
||||
|
||||
#### Provisioner Daemon API Version Mismatch
|
||||
@@ -343,13 +331,10 @@ connect to Coder.
|
||||
**Solution:** Update the provisioner daemon to match the currently running
|
||||
version of Coder.
|
||||
|
||||
<blockquote class="admonition note">
|
||||
|
||||
**Note:** This may be a transient issue if you are currently in the process of
|
||||
> [!NOTE]
|
||||
> This may be a transient issue if you are currently in the process of
|
||||
updating your deployment.
|
||||
|
||||
</blockquote>
|
||||
|
||||
### EUNKNOWN
|
||||
|
||||
#### Unknown Error
|
||||
|
||||
@@ -43,7 +43,8 @@ Agent logs are also stored in the workspace filesystem by default:
|
||||
[azure-windows](https://github.com/coder/coder/blob/2cfadad023cb7f4f85710cff0b21ac46bdb5a845/examples/templates/azure-windows/Initialize.ps1.tftpl#L64))
|
||||
to see where logs are stored.
|
||||
|
||||
> Note: Logs are truncated once they reach 5MB in size.
|
||||
> [!NOTE]
|
||||
> Logs are truncated once they reach 5MB in size.
|
||||
|
||||
Startup script logs are also stored in the temporary directory of macOS and
|
||||
Linux workspaces.
|
||||
|
||||
@@ -242,12 +242,9 @@ notification is indicated on the right hand side of this table.
|
||||
|
||||
## Delivery Preferences
|
||||
|
||||
<blockquote class="info">
|
||||
|
||||
Delivery preferences is an Enterprise and Premium feature.
|
||||
[Learn more](https://coder.com/pricing#compare-plans).
|
||||
|
||||
</blockquote>
|
||||
> [!NOTE]
|
||||
> Delivery preferences is an Enterprise and Premium feature.
|
||||
> [Learn more](https://coder.com/pricing#compare-plans).
|
||||
|
||||
Administrators can configure which delivery methods are used for each different
|
||||
[event type](#event-types).
|
||||
|
||||
@@ -181,12 +181,11 @@ To build the server to receive webhooks and interact with Slack:
|
||||
Slack requires the bot to acknowledge when a user clicks on a URL action button.
|
||||
This is handled by setting up interactivity.
|
||||
|
||||
1. Under "Interactivity & Shortcuts" in your Slack app settings, set the Request
|
||||
URL to match the public URL of your web server's endpoint.
|
||||
Under "Interactivity & Shortcuts" in your Slack app settings, set the Request
|
||||
URL to match the public URL of your web server's endpoint.
|
||||
|
||||
> Notice: You can use any public endpoint that accepts and responds to POST
|
||||
> requests with HTTP 200. For temporary testing, you can set it to
|
||||
> `https://httpbin.org/status/200`.
|
||||
You can use any public endpoint that accepts and responds to POST requests with HTTP 200.
|
||||
For temporary testing, you can set it to `https://httpbin.org/status/200`.
|
||||
|
||||
Once this is set, Slack will send interaction payloads to your server, which
|
||||
must respond appropriately.
|
||||
|
||||
Reference in New Issue
Block a user