Skip to content

Commit f1e15ad

Browse files
stirbystirby
committed
make fmt
1 parent b422368 commit f1e15ad

File tree

6 files changed

+45
-38
lines changed

6 files changed

+45
-38
lines changed

‎docs/admin/external-auth.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ GitHub provider).
3535
1. [Create a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
3636

3737
- Set the callback URL to
38-
`https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
38+
`https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
3939
- Deactivate Webhooks.
4040
- Enable fine-grained access to specific repositories or a subset of
41-
permissions for security.
41+
permissions for security.
4242

4343
![Register GitHub App](../images/admin/github-app-register.png)
4444

@@ -210,4 +210,3 @@ add this to the
210210
```shell
211211
git config --global credential.useHttpPath true
212212
```
213-

‎docs/admin/monitoring/metrics.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Deployment Metrics
22

3-
Coder exposes many metrics which give insight into the current state of a live Coder deployment. Our metrics are designed to be consumed by a [Prometheus server](https://prometheus.io/).
3+
Coder exposes many metrics which give insight into the current state of a live
4+
Coder deployment. Our metrics are designed to be consumed by a
5+
[Prometheus server](https://prometheus.io/).
46

57
If you don't have an Prometheus server installed, you can follow the Prometheus
68
[Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/)
79
guide.
810

911
### Seting up metrics
1012

11-
To set up metrics monitoring, please read our [Prometheus integration guide](../integrations/prometheus.md). The following links point to relevant sections there.
13+
To set up metrics monitoring, please read our
14+
[Prometheus integration guide](../integrations/prometheus.md). The following
15+
links point to relevant sections there.
1216

13-
- [Enable Prometheus metrics](../integrations/prometheus.md#enable-prometheus-metrics) in the control plane
14-
- [Enable the Prometheus endpoint in Helm](../integrations/prometheus.md#kubernetes-deployment) (Kubernetes users only)
17+
- [Enable Prometheus metrics](../integrations/prometheus.md#enable-prometheus-metrics)
18+
in the control plane
19+
- [Enable the Prometheus endpoint in Helm](../integrations/prometheus.md#kubernetes-deployment)
20+
(Kubernetes users only)
1521
- [Configure Prometheus to scrape Coder metrics](../integrations/prometheus.md#prometheus-configuration)
1622
- [See the list of available metrics](../integrations/prometheus.md#available-metrics)

‎docs/admin/setup.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ coder server
4040
## Wildcard access URL
4141

4242
`CODER_WILDCARD_ACCESS_URL` is necessary for
43-
[port forwarding](../admin/networking/port-forwarding.md#dashboard) via the dashboard
44-
or running [coder_apps](../admin/templates/README.md) on an absolute path.
45-
Set this to a wildcard subdomain that resolves to Coder (e.g.
43+
[port forwarding](../admin/networking/port-forwarding.md#dashboard) via the
44+
dashboard or running [coder_apps](../admin/templates/README.md) on an absolute
45+
path. Set this to a wildcard subdomain that resolves to Coder (e.g.
4646
`*.coder.example.com`).
4747

4848
If you are providing TLS certificates directly to the Coder server, either
@@ -141,11 +141,14 @@ To configure Coder behind a corporate proxy, set the environment variables
141141

142142
## External Authentication
143143

144-
Coder supports external authentication via OAuth2.0. This allows enabling integrations with git providers, such as GitHub, GitLab, and Bitbucket etc.
144+
Coder supports external authentication via OAuth2.0. This allows enabling
145+
integrations with git providers, such as GitHub, GitLab, and Bitbucket etc.
145146

146-
External authentication can also be used to integrate with external services like JFrog Artifactory and others.
147+
External authentication can also be used to integrate with external services
148+
like JFrog Artifactory and others.
147149

148-
Please refer to the [external authentication](../admin/external-auth.md) section for more information.
150+
Please refer to the [external authentication](../admin/external-auth.md) section
151+
for more information.
149152

150153
## Up Next
151154

‎docs/manifest.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"icon_path": "./images/icons/home.svg",
99
"children": [
1010
{
11-
"title":"Getting Started",
11+
"title": "Getting Started",
1212
"description": "Start here to learn about Coder",
1313
"path": "./install/README.md"
1414
},
@@ -41,7 +41,6 @@
4141
"description": "Install Coder using Docker",
4242
"path": "./install/docker.md",
4343
"icon_path": "./images/icons/docker.svg"
44-
4544
},
4645
{
4746
"title": "Kubernetes",

‎docs/reference/README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ activity.
7272
curl -X PATCH https://coder.example.com/api/v2/workspaceagents/me/logs \
7373
-H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
7474
-d "{
75-
\"logs\": [
76-
{
77-
\"created_at\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\",
78-
\"level\": \"info\",
79-
\"output\": \"Restoring workspace from snapshot: 05%...\"
80-
}
81-
]
75+
\"logs\": [
76+
{
77+
\"created_at\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\",
78+
\"level\": \"info\",
79+
\"output\": \"Restoring workspace from snapshot: 05%...\"
80+
}
81+
]
8282
}"
8383
```
8484

@@ -92,19 +92,19 @@ activity.
9292

9393
while true
9494
do
95-
if pgrep -f "my_training_script.py" > /dev/null
96-
then
97-
curl -X POST "https://coder.example.com/api/v2/workspaceagents/me/report-stats" \
98-
-H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
99-
-d '{
100-
"connection_count": 1
101-
}'
102-
103-
# Sleep for 30 minutes (1800 seconds) if the job is running
104-
sleep 1800
105-
else
106-
# Sleep for 1 minute (60 seconds) if the job is not running
107-
sleep 60
108-
fi
95+
if pgrep -f "my_training_script.py" > /dev/null
96+
then
97+
curl -X POST "https://coder.example.com/api/v2/workspaceagents/me/report-stats" \
98+
-H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
99+
-d '{
100+
"connection_count": 1
101+
}'
102+
103+
# Sleep for 30 minutes (1800 seconds) if the job is running
104+
sleep 1800
105+
else
106+
# Sleep for 1 minute (60 seconds) if the job is not running
107+
sleep 60
108+
fi
109109
done
110110
```

‎docs/user-guides/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# User Guides
22

3-
These guides contain information on workspace access via IDEs, environment personalization, and workspace scheduling. These contain no information on configuring [Templates](../admin/README.md) or the [control plane](../admin/README.md) and are only intended for end-user interaction.
4-
3+
These guides contain information on workspace access via IDEs, environment personalization, and workspace scheduling.
54

5+
These are intended for end-user flows only. If you are an administrator, please refer to our docs on configuring [templates](../admin/README.md) or the [control plane](../admin/README.md).
66

77
<children></children>

0 commit comments

Comments
 (0)