make fmt

stirby · stirby · commit f1e15ad55311 · 2024-09-10T16:38:58.000Z
diff --git a/docs/admin/external-auth.md b/docs/admin/external-auth.md
@@ -35,10 +35,10 @@ GitHub provider).
 1. [Create a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
 
    - Set the callback URL to
-	 `https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
+     `https://coder.example.com/external-auth/USER_DEFINED_ID/callback`.
    - Deactivate Webhooks.
    - Enable fine-grained access to specific repositories or a subset of
-	 permissions for security.
+     permissions for security.
 
    ![Register GitHub App](../images/admin/github-app-register.png)
 
@@ -210,4 +210,3 @@ add this to the
 ```shell
 git config --global credential.useHttpPath true
 ```
-
diff --git a/docs/admin/monitoring/metrics.md b/docs/admin/monitoring/metrics.md
@@ -1,16 +1,22 @@
 # Deployment Metrics
 
-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/).
+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/).
 
 If you don't have an Prometheus server installed, you can follow the Prometheus
 [Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/)
 guide.
 
 ### Seting up metrics
 
-To set up metrics monitoring, please read our [Prometheus integration guide](../integrations/prometheus.md). The following links point to relevant sections there.
+To set up metrics monitoring, please read our
+[Prometheus integration guide](../integrations/prometheus.md). The following
+links point to relevant sections there.
 
-- [Enable Prometheus metrics](../integrations/prometheus.md#enable-prometheus-metrics) in the control plane
-- [Enable the Prometheus endpoint in Helm](../integrations/prometheus.md#kubernetes-deployment) (Kubernetes users only)
+- [Enable Prometheus metrics](../integrations/prometheus.md#enable-prometheus-metrics)
+  in the control plane
+- [Enable the Prometheus endpoint in Helm](../integrations/prometheus.md#kubernetes-deployment)
+  (Kubernetes users only)
 - [Configure Prometheus to scrape Coder metrics](../integrations/prometheus.md#prometheus-configuration)
 - [See the list of available metrics](../integrations/prometheus.md#available-metrics)
diff --git a/docs/admin/setup.md b/docs/admin/setup.md
@@ -40,9 +40,9 @@ coder server
 ## Wildcard access URL
 
 `CODER_WILDCARD_ACCESS_URL` is necessary for
-[port forwarding](../admin/networking/port-forwarding.md#dashboard) via the dashboard
-or running [coder_apps](../admin/templates/README.md) on an absolute path.
-Set this to a wildcard subdomain that resolves to Coder (e.g.
+[port forwarding](../admin/networking/port-forwarding.md#dashboard) via the
+dashboard or running [coder_apps](../admin/templates/README.md) on an absolute
+path. Set this to a wildcard subdomain that resolves to Coder (e.g.
 `*.coder.example.com`).
 
 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
 
 ## External Authentication
 
-Coder supports external authentication via OAuth2.0. This allows enabling integrations with git providers, such as GitHub, GitLab, and Bitbucket etc.
+Coder supports external authentication via OAuth2.0. This allows enabling
+integrations with git providers, such as GitHub, GitLab, and Bitbucket etc.
 
-External authentication can also be used to integrate with external services like JFrog Artifactory and others.
+External authentication can also be used to integrate with external services
+like JFrog Artifactory and others.
 
-Please refer to the [external authentication](../admin/external-auth.md) section for more information.
+Please refer to the [external authentication](../admin/external-auth.md) section
+for more information.
 
 ## Up Next
 
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -8,7 +8,7 @@
 			"icon_path": "./images/icons/home.svg",
 			"children": [
 				{
-					"title":"Getting Started",
+					"title": "Getting Started",
 					"description": "Start here to learn about Coder",
 					"path": "./install/README.md"
 				},
@@ -41,7 +41,6 @@
 					"description": "Install Coder using Docker",
 					"path": "./install/docker.md",
 					"icon_path": "./images/icons/docker.svg"
-
 				},
 				{
 					"title": "Kubernetes",
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -72,13 +72,13 @@ activity.
   curl -X PATCH https://coder.example.com/api/v2/workspaceagents/me/logs \
   -H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
   -d "{
-	\"logs\": [
-	  {
-		\"created_at\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\",
-		\"level\": \"info\",
-		\"output\": \"Restoring workspace from snapshot: 05%...\"
-	  }
-	]
+  \"logs\": [
+    {
+  	\"created_at\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\",
+  	\"level\": \"info\",
+  	\"output\": \"Restoring workspace from snapshot: 05%...\"
+    }
+  ]
   }"
   ```
 
@@ -92,19 +92,19 @@ activity.
 
   while true
   do
-	if pgrep -f "my_training_script.py" > /dev/null
-	then
-	  curl -X POST "https://coder.example.com/api/v2/workspaceagents/me/report-stats" \
-	  -H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
-	  -d '{
-		"connection_count": 1
-	  }'
-
-	  # Sleep for 30 minutes (1800 seconds) if the job is running
-	  sleep 1800
-	else
-	  # Sleep for 1 minute (60 seconds) if the job is not running
-	  sleep 60
-	fi
+  if pgrep -f "my_training_script.py" > /dev/null
+  then
+    curl -X POST "https://coder.example.com/api/v2/workspaceagents/me/report-stats" \
+    -H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
+    -d '{
+  	"connection_count": 1
+    }'
+
+    # Sleep for 30 minutes (1800 seconds) if the job is running
+    sleep 1800
+  else
+    # Sleep for 1 minute (60 seconds) if the job is not running
+    sleep 60
+  fi
   done
   ```
diff --git a/docs/user-guides/README.md b/docs/user-guides/README.md
@@ -1,7 +1,7 @@
 # User Guides
 
-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.
-
+These guides contain information on workspace access via IDEs, environment personalization, and workspace scheduling.
 
+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).
 
 <children></children>
