fmt and typos

matifali · matifali · commit 5ca11b0496af · 2024-08-12T17:01:26.000+03:00
diff --git a/.github/workflows/typos.toml b/.github/workflows/typos.toml
@@ -22,6 +22,7 @@ pn = "pn"
 EDE = "EDE"
 # HELO is an SMTP command
 HELO = "HELO"
+LKE = "LKE"
 
 [files]
 extend-exclude = [
diff --git a/Makefile b/Makefile
@@ -632,15 +632,7 @@ coderd/rbac/object_gen.go: scripts/rbacgen/rbacobject.gotmpl scripts/rbacgen/mai
 codersdk/rbacresources_gen.go: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
 	go run scripts/rbacgen/main.go codersdk > codersdk/rbacresources_gen.go
 
-<<<<<<< HEAD
-site/src/api/rbacresources_gen.ts: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
-	go run scripts/rbacgen/main.go typescript > site/src/api/rbacresources_gen.ts
-
-
-docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
-=======
 docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
->>>>>>> 0e1703387 (modify prometheus location)
 	go run scripts/metricsdocgen/main.go
 	./scripts/pnpm_install.sh
 	pnpm exec prettier --write ./docs/admin/integrations/prometheus.md
diff --git a/docs/admin/integrations/README.md b/docs/admin/integrations/README.md
@@ -9,7 +9,7 @@ You can host your deployment on almost any infrastructure. To learn how, read ou
 
 The following resources may help as you're deploying Coder.
 
-- [Deploy workpsaces on multiple Kubernetes Clusters](./multiple-kube-clusters.md)
+- [Deploy workspaces on multiple Kubernetes Clusters](./multiple-kube-clusters.md)
 - [Get workspace build logs from Kubernetes](./kubernetes-logs.md)
 - [Track deployment metrics with Prometheus](./prometheus.md)
 - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages)
diff --git a/docs/admin/integrations/multiple-kube-clusters.md b/docs/admin/integrations/multiple-kube-clusters.md
@@ -58,8 +58,8 @@ If you deployed Coder on a VM, copy the kubeconfig file to
 
 You can start from our
 [example template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes).
-From there, add [template parameters](../../templates/concepts/parameters.md) to allow
-developers to pick their desired cluster.
+From there, add [template parameters](../../templates/concepts/parameters.md) to
+allow developers to pick their desired cluster.
 
 ```hcl
 # main.tf
diff --git a/docs/admin/integrations/opentofu.md b/docs/admin/integrations/opentofu.md
@@ -2,16 +2,22 @@
 
 <!-- Keeping this in as a placeholder for supporting OpenTofu. We should fix support for custom terraform binaries ASAP. -->
 
-> ⚠️ This guide is a work in progress. We do not officially support using custom Terraform binaries in your Coder deployment. To track progress on the work, see this related [Github Issue](https://github.com/coder/coder/issues/12009). 
-
-Coder deployments support any custom Terraform binary, including [OpenTofu](https://opentofu.org/docs/) - an open source alternative to Terraform. 
-
-> You can read more about OpenTofu and Hashicorp's licensing in our [blog post](https://coder.com/blog/hashicorp-license) on the Terraform licensing changes. 
+> ⚠️ This guide is a work in progress. We do not officially support using custom
+> Terraform binaries in your Coder deployment. To track progress on the work,
+> see this related [Github Issue](https://github.com/coder/coder/issues/12009).
 
+Coder deployments support any custom Terraform binary, including
+[OpenTofu](https://opentofu.org/docs/) - an open source alternative to
+Terraform.
 
+> You can read more about OpenTofu and Hashicorp's licensing in our
+> [blog post](https://coder.com/blog/hashicorp-license) on the Terraform
+> licensing changes.
 
 ## Using a custom Terraform binary
 
-You can change your deployment custom Terraform binary as long as it is in `PATH` and is within the [supported versions](https://github.com/coder/coder/blob/f57ce97b5aadd825ddb9a9a129bb823a3725252b/provisioner/terraform/install.go#L22-L25). The hardcoded version check ensures compatibility with our [example templates](https://github.com/coder/coder/tree/main/examples/templates).
-
-
+You can change your deployment custom Terraform binary as long as it is in
+`PATH` and is within the
+[supported versions](https://github.com/coder/coder/blob/f57ce97b5aadd825ddb9a9a129bb823a3725252b/provisioner/terraform/install.go#L22-L25).
+The hardcoded version check ensures compatibility with our
+[example templates](https://github.com/coder/coder/tree/main/examples/templates).
diff --git a/docs/admin/integrations/vault.md b/docs/admin/integrations/vault.md
@@ -1,4 +1,3 @@
-
 # Integrating HashiCorp Vault with Coder
 
 <div>
diff --git a/docs/admin/monitoring/health-check.md b/docs/admin/monitoring/health-check.md
@@ -3,7 +3,7 @@
 Coder includes an operator-friendly deployment health page that provides a
 number of details about the health of your Coder deployment.
 
-![Health check in Coder Dashbord](../../images/admin/monitoring/health-check.png)
+![Health check in Coder Dashboard](../../images/admin/monitoring/health-check.png)
 
 You can view it at `https://${CODER_URL}/health`, or you can alternatively view
 the [JSON response directly](../api/debug.md#debug-info-deployment-health).
diff --git a/docs/admin/security/secrets.md b/docs/admin/security/secrets.md
@@ -1,4 +1,3 @@
-
 # Secrets
 
 <blockquote class="info">
diff --git a/docs/admin/templates/extending-templates/README.md b/docs/admin/templates/extending-templates/README.md
@@ -2,11 +2,11 @@
 
 <!-- TODO: Review structure and links -->
 
-There are a variety of Coder-native features to extend the configuration of your development environments. Many of the following features are defined in your templates using the [Coder Terraform provider](https://registry.terraform.io/providers/coder/coder/latest/docs). The provider docs will provide code examples for usage; alternatively, you can view our [example templates](https://github.com/coder/coder/tree/main/examples/templates) to get started.  
+There are a variety of Coder-native features to extend the configuration of your development environments. Many of the following features are defined in your templates using the [Coder Terraform provider](https://registry.terraform.io/providers/coder/coder/latest/docs). The provider docs will provide code examples for usage; alternatively, you can view our [example templates](https://github.com/coder/coder/tree/main/examples/templates) to get started.
 
 ## Workspace agents
 
-For users to connect to a workspace, the template must include a [`coder_agent`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent). The associated agent will facilitate [workspace connections](../../../user-guides/workspace-access/README.md) via SSH, port forwarding, and IDEs. The agent may also display real-time [workspace metadata](./agent-metadata.md) like resource usage. 
+For users to connect to a workspace, the template must include a [`coder_agent`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent). The associated agent will facilitate [workspace connections](../../../user-guides/workspace-access/README.md) via SSH, port forwarding, and IDEs. The agent may also display real-time [workspace metadata](./agent-metadata.md) like resource usage.
 
 ```hcl
 resource "coder_agent" "dev" {
@@ -21,23 +21,22 @@ resource "coder_agent" "dev" {
 
 You can also leverage [resource metadata](./resource-metadata.md) to display static resource information from your template.
 
-Templates must include some computational resource to start the agent. All processes on the workspace are then spawned from the agent. It also provides all information displayed in the dashboard's workspace view. 
+Templates must include some computational resource to start the agent. All processes on the workspace are then spawned from the agent. It also provides all information displayed in the dashboard's workspace view.
 
 ![A healthy workspace agent](../../../images/templates/healthy-workspace-agent.png)
 
-Multiple agents may be used in a single template or even a single resource. Each agent may have it's own apps, startup script, and metadata. This can be used to associate multiple containers or VMs with a workspace. 
+Multiple agents may be used in a single template or even a single resource. Each agent may have it's own apps, startup script, and metadata. This can be used to associate multiple containers or VMs with a workspace.
 
 ## Resource persistence
 
 The resources you define in a template may be _ephemeral_ or _persistent_. Persistent resources stay provisioned when workspaces are stopped, where as ephemeral resources are destroyed and recreated on restart. All resources are destroyed when a workspace is deleted.
 
-> You can read more about how resource behavior and workspace state in the  [workspace lifecycle documentation](../../workspaces/lifecycle.md).
+> You can read more about how resource behavior and workspace state in the [workspace lifecycle documentation](../../workspaces/lifecycle.md).
 
 Template resources follow the [behavior of Terraform resources](https://developer.hashicorp.com/terraform/language/resources/behavior#how-terraform-applies-a-configuration) and can be further configured  using the [lifecycle argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle).
 
 A common configuration is a template whose only persistent resource is the home directory. This allows the developer to retain their work while ensuring the rest of their environment is consistently up-to-date on each workspace restart.
 
-
 ## Coder apps
 
 Additional IDEs, documentation, or services can be associated to your workspace using the [`coder_app`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app) resource.
@@ -46,7 +45,7 @@ Additional IDEs, documentation, or services can be associated to your workspace
 
 Note that some apps are associated to the agent by default as [`display_apps`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps) and can be hidden directly in the [`coder_agent`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent) resource. You can arrange the display orientation of Coder apps in your template using [resource ordering](./resource-ordering.md).
 
-Check out our [module registry](https://registry.coder.com/modules) for additional Coder apps from the team and our OSS community. 
+Check out our [module registry](https://registry.coder.com/modules) for additional Coder apps from the team and our OSS community.
 
 <children>
 
diff --git a/docs/admin/templates/extending-templates/agent-metadata.md b/docs/admin/templates/extending-templates/agent-metadata.md
@@ -15,10 +15,10 @@ All of these examples use
 for the script declaration. With heredoc strings, you can script without messy
 escape codes, just as if you were working in your terminal.
 
-Some of the examples use the [`coder stat`](../../../reference/cli/stat.md) command. This is
-useful for determining CPU and memory usage of the VM or container that the
-workspace is running in, which is more accurate than resource usage about the
-workspace's host.
+Some of the examples use the [`coder stat`](../../../reference/cli/stat.md)
+command. This is useful for determining CPU and memory usage of the VM or
+container that the workspace is running in, which is more accurate than resource
+usage about the workspace's host.
 
 Here's a standard set of metadata snippets for Linux agents:
 
diff --git a/docs/admin/templates/managing-templates.md b/docs/admin/templates/managing-templates.md
@@ -60,7 +60,12 @@ infrastructure, software, or security patches. Learn more about
 
 ### Template update policies (enterprise)
 
-Enterprise template admins may want workspaces to always remain on the latest version of their parent template. To do so, enable **Template Update Policies** in the template's general settings. All non-admin users of the template will be forced to update their workspaces before starting them once the setting is applied. Workspaces which leverage autostart or start-on-connect will be automatically updated on the next startup.
+Enterprise template admins may want workspaces to always remain on the latest
+version of their parent template. To do so, enable **Template Update Policies**
+in the template's general settings. All non-admin users of the template will be
+forced to update their workspaces before starting them once the setting is
+applied. Workspaces which leverage autostart or start-on-connect will be
+automatically updated on the next startup.
 
 ![Template update policies](../../images/templates/update-policies.png)
 
diff --git a/docs/admin/users/organizations.md b/docs/admin/users/organizations.md
@@ -9,4 +9,5 @@ Organizations are a logical bucket of users with unique administrators,
 templates, provisioners, and workspaces into the Coder platform.
 
 ## Organizations vs Groups
+
 TODO
diff --git a/docs/admin/workspaces/README.md b/docs/admin/workspaces/README.md
@@ -1,6 +1,6 @@
 # Administering workspaces
 
-<!-- 
+<!--
 Layout of admin/workspaces/
 
 README.md
@@ -37,7 +37,6 @@ The following filters are supported:
   statuses, see
   [WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus).
 
-
 ## Updating workspaces
 
 After updating the default version of the template that a workspace was created
@@ -56,6 +55,7 @@ Update a workspace through the command line:
 ```shell
 coder update <workspace-name>
 ```
+
 ### Automatic updates
 
 It can be tedious to manually update a workspace every time an update is pushed
@@ -72,7 +72,6 @@ manually updated the workspace.
 
 Template admins can require workspaces be on the latest version before starting. When this is enabled, you will be presented with an "Update and Start" button in the UI. Workspaces that start on connect will automatically update on the first out-of-date connection.
 
-
 <!-- TODO: Link force update policies -->
 
 ## Bulk operations (enterprise)
diff --git a/docs/admin/workspaces/lifecycle.md b/docs/admin/workspaces/lifecycle.md
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md
diff --git a/docs/user-guides/README.md b/docs/user-guides/README.md
diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md
diff --git a/docs/user-guides/workspace-scheduling.md b/docs/user-guides/workspace-scheduling.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`# Integrating HashiCorp Vault with Coder`
`3`	`2`
`4`	`3`	`<div>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`# Secrets`
`3`	`2`
`4`	`3`	`<blockquote class="info">`