Skip to content

Commit d34a38c

Browse files
matifalimatifali
committed
make fmt
1 parent d494281 commit d34a38c

File tree

5 files changed

+34
-30
lines changed

5 files changed

+34
-30
lines changed

‎docs/admin/audit-logs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ information about this in our
7777
Audit trails are also dispatched as service logs and can be captured and
7878
categorized using any log management tool such as [Splunk](https://splunk.com).
7979

80-
Example of a [JSON formatted](../reference/cli/server.md#--log-json) audit log entry:
80+
Example of a [JSON formatted](../reference/cli/server.md#--log-json) audit log
81+
entry:
8182

8283
```json
8384
{
@@ -112,7 +113,8 @@ Example of a [JSON formatted](../reference/cli/server.md#--log-json) audit log e
112113
}
113114
```
114115

115-
Example of a [human readable](../reference/cli/server.md#--log-human) audit log entry:
116+
Example of a [human readable](../reference/cli/server.md#--log-human) audit log
117+
entry:
116118

117119
```console
118120
2023-06-13 03:43:29.233 [info] coderd: audit_log ID=95f7c392-da3e-480c-a579-8909f145fbe2 Time="2023-06-13T03:43:29.230422Z" UserID=6c405053-27e3-484a-9ad7-bcb64e7bfde6 OrganizationID=00000000-0000-0000-0000-000000000000 Ip=<nil> UserAgent=<nil> ResourceType=workspace_build ResourceID=988ae133-5b73-41e3-a55e-e1e9d3ef0b66 ResourceTarget="" Action=start Diff="{}" StatusCode=200 AdditionalFields="{\"workspace_name\":\"linux-container\",\"build_number\":\"7\",\"build_reason\":\"initiator\",\"workspace_owner\":\"\"}" RequestID=9682b1b5-7b9f-4bf2-9a39-9463f8e41cd6 ResourceIcon=""

‎docs/admin/automation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
3333
## Documentation
3434

3535
We publish an [API reference](../api/index.md) in our documentation. You can
36-
also enable a [Swagger endpoint](../reference/cli/server.md#--swagger-enable) on your
37-
Coder deployment.
36+
also enable a [Swagger endpoint](../reference/cli/server.md#--swagger-enable) on
37+
your Coder deployment.
3838

3939
## Use cases
4040

‎docs/admin/configure.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,11 @@ If you are providing TLS certificates directly to the Coder server, either
4848
1. Use a single certificate and key for both the root and wildcard domains.
4949
2. Configure multiple certificates and keys via
5050
[`coder.tls.secretNames`](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
51-
in the Helm Chart, or [`--tls-cert-file`](../reference/cli/server.md#--tls-cert-file)
52-
and [`--tls-key-file`](../reference/cli/server.md#--tls-key-file) command line options
53-
(these both take a comma separated list of files; list certificates and their
54-
respective keys in the same order).
51+
in the Helm Chart, or
52+
[`--tls-cert-file`](../reference/cli/server.md#--tls-cert-file) and
53+
[`--tls-key-file`](../reference/cli/server.md#--tls-key-file) command line
54+
options (these both take a comma separated list of files; list certificates
55+
and their respective keys in the same order).
5556

5657
## TLS & Reverse Proxy
5758

‎docs/admin/healthcheck.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ query fails.
106106
_Database Latency High_
107107

108108
**Problem:** This code is returned if the median latency is higher than the
109-
[configured threshold](../reference/cli/server.md#--health-check-threshold-database). This
110-
may not be an error as such, but is an indication of a potential issue.
109+
[configured threshold](../reference/cli/server.md#--health-check-threshold-database).
110+
This may not be an error as such, but is an indication of a potential issue.
111111

112112
**Solution:** Investigate the sizing of the configured database with regard to
113113
Coder's current activity and usage. It may be necessary to increase the
@@ -119,16 +119,17 @@ configured threshold to a higher value (this will not address the root cause).
119119
> - You can enable
120120
> [detailed database metrics](../reference/cli/server.md#--prometheus-collect-db-metrics)
121121
> in Coder's Prometheus endpoint.
122-
> - If you have [tracing enabled](../reference/cli/server.md#--trace), these traces may
123-
> also contain useful information regarding Coder's database activity.
122+
> - If you have [tracing enabled](../reference/cli/server.md#--trace), these
123+
> traces may also contain useful information regarding Coder's database
124+
> activity.
124125
125126
## DERP
126127

127128
Coder workspace agents may use
128129
[DERP (Designated Encrypted Relay for Packets)](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp)
129130
to communicate with Coder. This requires connectivity to a number of configured
130-
[DERP servers](../reference/cli/server.md#--derp-config-path) which are used to relay
131-
traffic between Coder and workspace agents. Coder periodically queries the
131+
[DERP servers](../reference/cli/server.md#--derp-config-path) which are used to
132+
relay traffic between Coder and workspace agents. Coder periodically queries the
132133
health of its configured DERP servers and may return one or more of the
133134
following:
134135

@@ -179,9 +180,9 @@ to establish [direct connections](../networking/stun.md). Without at least one
179180
working STUN server, direct connections may not be possible.
180181

181182
**Solution:** Ensure that the
182-
[configured STUN severs](../reference/cli/server.md#derp-server-stun-addresses) are
183-
reachable from Coder and that UDP traffic can be sent/received on the configured
184-
port.
183+
[configured STUN severs](../reference/cli/server.md#derp-server-stun-addresses)
184+
are reachable from Coder and that UDP traffic can be sent/received on the
185+
configured port.
185186

186187
### ESTUN02
187188

@@ -292,8 +293,8 @@ be built until there is at least one provisioner daemon running.
292293
If you are using
293294
[External Provisioner Daemons](./provisioners.md#external-provisioners), ensure
294295
that they are able to successfully connect to Coder. Otherwise, ensure
295-
[`--provisioner-daemons`](../reference/cli/server.md#provisioner-daemons) is set to a
296-
value greater than 0.
296+
[`--provisioner-daemons`](../reference/cli/server.md#provisioner-daemons) is set
297+
to a value greater than 0.
297298

298299
> Note: This may be a transient issue if you are currently in the process of
299300
> updating your deployment.

‎docs/install/offline.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ environments. However, some changes to your configuration are necessary.
66
> This is a general comparison. Keep reading for a full tutorial running Coder
77
> offline with Kubernetes or Docker.
88
9-
| | Public deployments | Offline deployments |
10-
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11-
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
12-
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
9+
| | Public deployments | Offline deployments |
10+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
12+
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
1313
| STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../reference/ users can still connect via [relayed connections](../networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../reference/cli/server.md#--derp-server-stun-addresses) |
14-
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking/index.md#custom-relays). |
15-
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
16-
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
17-
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
14+
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../networking/index.md#custom-relays). |
15+
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
16+
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
17+
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
1818

1919
## Offline container images
2020

@@ -223,9 +223,9 @@ server, as demonstrated in the example below:
223223
3. Extract the file and move its contents to your server folder.
224224
4. If you are using NodeJS, you can execute the following command:
225225
`cd docs && npx http-server .`
226-
5. Set the [CODER_DOCS_URL](../reference/cli/server.md#--docs-url) environment variable to
227-
use the URL of your hosted docs. This way, the Coder UI will reference the
228-
documentation from your specified URL.
226+
5. Set the [CODER_DOCS_URL](../reference/cli/server.md#--docs-url) environment
227+
variable to use the URL of your hosted docs. This way, the Coder UI will
228+
reference the documentation from your specified URL.
229229

230230
With these steps, you'll have the Coder documentation hosted on your server and
231231
accessible for your team to use.

0 commit comments

Comments
 (0)