From a80f3edcde32d56820430423924a729c0a54a73e Mon Sep 17 00:00:00 2001 From: Nick Vigilante Date: Tue, 11 Aug 2026 19:37:08 +0000 Subject: [PATCH 1/2] docs: reconcile H1/label mismatches into front-matter titles (Phase 3) Batch B of the Phase 3 H1 to front-matter migration (DOCS-484, parent DOCS-477). For the 124 hand-authored pages whose body H1 differed from the manifest nav label, promote the richer body H1 to the front-matter page title and drop the duplicate H1, keeping the short manifest label as the sidebar entry (policy agreed with the docs owner). Page-title collisions are resolved by renaming the non-generated page: - install/cli.md -> "Install the Coder CLI" (vs install landing "Installing Coder") - ai-gateway/clients/jetbrains.md -> "JetBrains" - extending-templates/web-ides.md -> "Web IDEs in templates" - workspace-management.md -> "Manage workspaces" (vs generated api/workspaces.md) Duplicate sidebar labels are acceptable; identical page titles are not. Generated pages (audit-logs, configuration-reference) are excluded; their generators must emit front matter first (tracked separately). Also drops a now-dangling in-page #mcp fragment in ai-gateway/mcp.md. --- docs/about/contributing/CODE_OF_CONDUCT.md | 4 +++- docs/about/contributing/SECURITY.md | 4 +++- docs/about/contributing/modules.md | 4 +++- docs/about/contributing/templates.md | 4 +++- docs/admin/infrastructure/scale-utility.md | 4 +++- .../infrastructure/validated-architectures/10k-users.md | 4 +++- .../infrastructure/validated-architectures/1k-users.md | 4 +++- .../infrastructure/validated-architectures/2k-users.md | 4 +++- .../infrastructure/validated-architectures/3k-users.md | 4 +++- docs/admin/infrastructure/validated-architectures/index.md | 4 +++- .../envbuilder/envbuilder-releases-known-issues.md | 4 +++- .../devcontainers/envbuilder/envbuilder-security-caching.md | 4 +++- docs/admin/integrations/devcontainers/integration.md | 4 +++- docs/admin/integrations/dx-data-cloud.md | 4 +++- docs/admin/integrations/island.md | 4 +++- docs/admin/integrations/istio.md | 4 +++- docs/admin/integrations/jfrog-artifactory.md | 4 +++- docs/admin/integrations/kubernetes-logs.md | 4 +++- docs/admin/integrations/multiple-kube-clusters.md | 4 +++- docs/admin/integrations/oauth2-provider.md | 4 +++- docs/admin/integrations/vault.md | 4 +++- docs/admin/monitoring/connection-logs.md | 4 +++- docs/admin/monitoring/health-check.md | 4 +++- docs/admin/monitoring/index.md | 4 +++- docs/admin/monitoring/metrics.md | 4 +++- docs/admin/networking/wildcard-access-url.md | 4 +++- docs/admin/networking/workspace-proxies.md | 4 +++- docs/admin/provisioners/index.md | 4 +++- docs/admin/provisioners/manage-provisioner-jobs.md | 4 +++- docs/admin/setup/appearance.md | 4 +++- docs/admin/setup/chat-lifecycle-hooks.md | 4 +++- docs/admin/setup/index.md | 4 +++- docs/admin/templates/extending-templates/agent-metadata.md | 4 +++- .../templates/extending-templates/environment-variables.md | 4 +++- docs/admin/templates/extending-templates/index.md | 4 +++- .../templates/extending-templates/jetbrains-airgapped.md | 4 +++- .../templates/extending-templates/jetbrains-preinstall.md | 4 +++- docs/admin/templates/extending-templates/modules.md | 4 +++- docs/admin/templates/extending-templates/parameters.md | 4 +++- docs/admin/templates/extending-templates/process-logging.md | 4 +++- .../templates/extending-templates/resource-monitoring.md | 4 +++- .../templates/extending-templates/resource-ordering.md | 4 +++- .../templates/extending-templates/resource-persistence.md | 4 +++- docs/admin/templates/extending-templates/variables.md | 4 +++- docs/admin/templates/extending-templates/web-ides.md | 4 +++- docs/admin/templates/index.md | 4 +++- .../admin/templates/managing-templates/change-management.md | 4 +++- docs/admin/templates/managing-templates/index.md | 4 +++- docs/admin/templates/startup-coordination/example.md | 4 +++- docs/admin/templates/startup-coordination/index.md | 4 +++- .../admin/templates/startup-coordination/troubleshooting.md | 4 +++- docs/admin/templates/startup-coordination/usage.md | 4 +++- docs/admin/templates/template-permissions.md | 4 +++- docs/admin/templates/troubleshooting.md | 4 +++- docs/admin/users/github-auth.md | 4 +++- docs/admin/users/groups-roles.md | 4 +++- docs/admin/users/oidc-auth/google.md | 4 +++- docs/admin/users/oidc-auth/index.md | 4 +++- docs/admin/users/oidc-auth/microsoft.md | 4 +++- docs/admin/users/organizations.md | 4 +++- docs/admin/users/sessions-tokens.md | 4 +++- docs/ai-coder/agent-compatibility.md | 4 +++- docs/ai-coder/agent-firewall/landjail.md | 4 +++- docs/ai-coder/agent-firewall/nsjail/docker.md | 4 +++- docs/ai-coder/agent-firewall/nsjail/ecs.md | 4 +++- docs/ai-coder/agent-firewall/nsjail/index.md | 4 +++- docs/ai-coder/agent-firewall/nsjail/k8s.md | 4 +++- docs/ai-coder/agent-firewall/rules-engine.md | 4 +++- docs/ai-coder/agent-firewall/version.md | 4 +++- docs/ai-coder/agents/chat-search-syntax.md | 4 +++- docs/ai-coder/agents/platform-controls/chat-auto-archive.md | 4 +++- .../agents/platform-controls/chat-debug-retention.md | 4 +++- docs/ai-coder/agents/platform-controls/chat-retention.md | 4 +++- docs/ai-coder/agents/platform-controls/spend-management.md | 4 +++- docs/ai-coder/agents/tasks-to-chats-migration.md | 4 +++- docs/ai-coder/ai-gateway/clients/codex.md | 4 +++- docs/ai-coder/ai-gateway/clients/jetbrains.md | 4 +++- docs/ai-coder/ai-gateway/mcp.md | 6 ++++-- docs/ai-coder/ai-gateway/standalone.md | 4 +++- docs/ai-coder/github-to-tasks.md | 4 +++- docs/ai-coder/tasks-lifecycle.md | 4 +++- docs/ai-coder/tasks-migration.md | 4 +++- docs/get-started/customize-your-template/add-a-language.md | 4 +++- docs/get-started/index.md | 4 +++- docs/install/cli.md | 4 +++- docs/install/cloud/aws-marketplace.md | 4 +++- docs/install/cloud/azure-vm.md | 4 +++- docs/install/cloud/compute-engine.md | 4 +++- docs/install/cloud/index.md | 4 +++- docs/install/docker.md | 4 +++- docs/install/index.md | 4 +++- docs/install/kubernetes.md | 4 +++- docs/install/other/index.md | 4 +++- docs/install/rancher.md | 4 +++- docs/install/registry-mirror-artifactory.md | 4 +++- docs/install/upgrade.md | 4 +++- docs/reference/agent-api/index.md | 4 +++- docs/support/support-bundle.md | 4 +++- docs/tutorials/azure-federation.md | 4 +++- docs/tutorials/best-practices/scale-coder.md | 4 +++- docs/tutorials/best-practices/speed-up-templates.md | 4 +++- docs/tutorials/configuring-okta.md | 4 +++- docs/tutorials/external-database.md | 4 +++- docs/tutorials/gcp-to-aws.md | 4 +++- docs/tutorials/image-pull-secret.md | 4 +++- docs/tutorials/index.md | 4 +++- docs/tutorials/persistent-shared-workspaces.md | 4 +++- docs/tutorials/postgres-ssl.md | 4 +++- docs/tutorials/reverse-proxy-apache.md | 4 +++- docs/tutorials/reverse-proxy-caddy.md | 4 +++- docs/tutorials/reverse-proxy-nginx.md | 4 +++- docs/tutorials/template-from-scratch.md | 4 +++- docs/tutorials/testing-templates.md | 4 +++- .../devcontainers/working-with-dev-containers.md | 4 +++- docs/user-guides/shared-workspaces.md | 4 +++- docs/user-guides/workspace-access/filebrowser.md | 4 +++- docs/user-guides/workspace-access/index.md | 4 +++- docs/user-guides/workspace-access/jetbrains/toolbox.md | 4 +++- docs/user-guides/workspace-access/port-forwarding.md | 4 +++- docs/user-guides/workspace-access/remote-desktops.md | 4 +++- docs/user-guides/workspace-access/web-ides.md | 4 +++- docs/user-guides/workspace-lifecycle.md | 4 +++- docs/user-guides/workspace-management.md | 4 +++- docs/user-guides/workspace-scheduling.md | 4 +++- 124 files changed, 373 insertions(+), 125 deletions(-) diff --git a/docs/about/contributing/CODE_OF_CONDUCT.md b/docs/about/contributing/CODE_OF_CONDUCT.md index 64fe6bfd8d4..343f934ce05 100644 --- a/docs/about/contributing/CODE_OF_CONDUCT.md +++ b/docs/about/contributing/CODE_OF_CONDUCT.md @@ -1,4 +1,6 @@ -# Contributor Covenant Code of Conduct +--- +title: Contributor Covenant Code of Conduct +--- ## Our Pledge diff --git a/docs/about/contributing/SECURITY.md b/docs/about/contributing/SECURITY.md index 7d0f2673ae1..cdee8509016 100644 --- a/docs/about/contributing/SECURITY.md +++ b/docs/about/contributing/SECURITY.md @@ -1,4 +1,6 @@ -# Security Policy +--- +title: Security Policy +--- Coder welcomes feedback from security researchers and the general public to help improve our security. If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues diff --git a/docs/about/contributing/modules.md b/docs/about/contributing/modules.md index 4c91a04da12..781fb917575 100644 --- a/docs/about/contributing/modules.md +++ b/docs/about/contributing/modules.md @@ -1,4 +1,6 @@ -# Contributing modules +--- +title: Contributing modules +--- Learn how to create and contribute Terraform modules to the Coder Registry. Modules provide reusable components that extend Coder workspaces with IDEs, development tools, login tools, and other features. diff --git a/docs/about/contributing/templates.md b/docs/about/contributing/templates.md index 3be4f9aa266..c4d65865d7a 100644 --- a/docs/about/contributing/templates.md +++ b/docs/about/contributing/templates.md @@ -1,4 +1,6 @@ -# Contributing templates +--- +title: Contributing templates +--- Learn how to create and contribute complete Coder workspace templates to the Coder Registry. Templates provide ready-to-use workspace configurations that users can deploy directly to create development environments. diff --git a/docs/admin/infrastructure/scale-utility.md b/docs/admin/infrastructure/scale-utility.md index 5da9b0f0b13..628657a79a5 100644 --- a/docs/admin/infrastructure/scale-utility.md +++ b/docs/admin/infrastructure/scale-utility.md @@ -1,4 +1,6 @@ -# Scale Tests and Utilities +--- +title: Scale Tests and Utilities +--- We scale-test Coder with a built-in utility that can be used in your environment for insights into how Coder scales with your diff --git a/docs/admin/infrastructure/validated-architectures/10k-users.md b/docs/admin/infrastructure/validated-architectures/10k-users.md index 95ea14f4010..f0bf3e5908e 100644 --- a/docs/admin/infrastructure/validated-architectures/10k-users.md +++ b/docs/admin/infrastructure/validated-architectures/10k-users.md @@ -1,4 +1,6 @@ -# Reference Architecture: up to 10,000 users +--- +title: "Reference Architecture: up to 10,000 users" +--- The 10,000 users architecture targets enterprises with an extremely large global workforce of technical professionals or applications requiring lots of simultaneous workspaces (for example, Agentic AI). diff --git a/docs/admin/infrastructure/validated-architectures/1k-users.md b/docs/admin/infrastructure/validated-architectures/1k-users.md index af848f329b1..e2e0f2c4deb 100644 --- a/docs/admin/infrastructure/validated-architectures/1k-users.md +++ b/docs/admin/infrastructure/validated-architectures/1k-users.md @@ -1,4 +1,6 @@ -# Reference Architecture: up to 1,000 users +--- +title: "Reference Architecture: up to 1,000 users" +--- The 1,000 users architecture is designed to cover a wide range of workflows. Examples of subjects that might utilize this architecture include medium-sized diff --git a/docs/admin/infrastructure/validated-architectures/2k-users.md b/docs/admin/infrastructure/validated-architectures/2k-users.md index fb0dd5a21ed..1e052f77980 100644 --- a/docs/admin/infrastructure/validated-architectures/2k-users.md +++ b/docs/admin/infrastructure/validated-architectures/2k-users.md @@ -1,4 +1,6 @@ -# Reference Architecture: up to 2,000 users +--- +title: "Reference Architecture: up to 2,000 users" +--- In the 2,000 users architecture, there is a moderate increase in traffic, suggesting a growing user base or expanding operations. This setup is diff --git a/docs/admin/infrastructure/validated-architectures/3k-users.md b/docs/admin/infrastructure/validated-architectures/3k-users.md index 21aa7916ece..6ac32a57f8b 100644 --- a/docs/admin/infrastructure/validated-architectures/3k-users.md +++ b/docs/admin/infrastructure/validated-architectures/3k-users.md @@ -1,4 +1,6 @@ -# Reference Architecture: up to 3,000 users +--- +title: "Reference Architecture: up to 3,000 users" +--- The 3,000 users architecture targets large-scale enterprises, possibly with on-premises network and cloud deployments. diff --git a/docs/admin/infrastructure/validated-architectures/index.md b/docs/admin/infrastructure/validated-architectures/index.md index 8c037a64337..6fc9430ad72 100644 --- a/docs/admin/infrastructure/validated-architectures/index.md +++ b/docs/admin/infrastructure/validated-architectures/index.md @@ -1,4 +1,6 @@ -# Coder Validated Architecture +--- +title: Coder Validated Architecture +--- Many customers operate Coder in complex organizational environments, consisting of multiple business units, agencies, and/or subsidiaries. This can lead to diff --git a/docs/admin/integrations/devcontainers/envbuilder/envbuilder-releases-known-issues.md b/docs/admin/integrations/devcontainers/envbuilder/envbuilder-releases-known-issues.md index 721d75bab98..da3e85818a5 100644 --- a/docs/admin/integrations/devcontainers/envbuilder/envbuilder-releases-known-issues.md +++ b/docs/admin/integrations/devcontainers/envbuilder/envbuilder-releases-known-issues.md @@ -1,4 +1,6 @@ -# Envbuilder releases and known issues +--- +title: Envbuilder releases and known issues +--- ## Release channels diff --git a/docs/admin/integrations/devcontainers/envbuilder/envbuilder-security-caching.md b/docs/admin/integrations/devcontainers/envbuilder/envbuilder-security-caching.md index fa61bf360df..0081973a189 100644 --- a/docs/admin/integrations/devcontainers/envbuilder/envbuilder-security-caching.md +++ b/docs/admin/integrations/devcontainers/envbuilder/envbuilder-security-caching.md @@ -1,4 +1,6 @@ -# Envbuilder security and caching +--- +title: Envbuilder security and caching +--- Ensure Envbuilder can only pull pre-approved images and artifacts by configuring it with your existing HTTP proxies, firewalls, and artifact managers. diff --git a/docs/admin/integrations/devcontainers/integration.md b/docs/admin/integrations/devcontainers/integration.md index 6c40fdee428..47745059ad5 100644 --- a/docs/admin/integrations/devcontainers/integration.md +++ b/docs/admin/integrations/devcontainers/integration.md @@ -1,4 +1,6 @@ -# Configure a template for Dev Containers +--- +title: Configure a template for Dev Containers +--- This guide covers the Dev Containers Integration, which uses Docker. For environments without Docker, see [Envbuilder](./envbuilder/index.md) as an diff --git a/docs/admin/integrations/dx-data-cloud.md b/docs/admin/integrations/dx-data-cloud.md index ee4f486a6ca..04bd1b516ed 100644 --- a/docs/admin/integrations/dx-data-cloud.md +++ b/docs/admin/integrations/dx-data-cloud.md @@ -1,4 +1,6 @@ -# DX +--- +title: DX +--- [DX](https://getdx.com) is a developer intelligence platform used by engineering leaders and platform engineers. diff --git a/docs/admin/integrations/island.md b/docs/admin/integrations/island.md index 97de83af2b5..379cfd464e6 100644 --- a/docs/admin/integrations/island.md +++ b/docs/admin/integrations/island.md @@ -1,4 +1,6 @@ -# Island Browser Integration +--- +title: Island Browser Integration +---
diff --git a/docs/admin/integrations/istio.md b/docs/admin/integrations/istio.md index 3132052e327..d54eb9cb597 100644 --- a/docs/admin/integrations/istio.md +++ b/docs/admin/integrations/istio.md @@ -1,4 +1,6 @@ -# Integrate Coder with Istio +--- +title: Integrate Coder with Istio +--- Use Istio service mesh for your Coder workspace traffic to implement access controls, encrypt service-to-service communication, and gain visibility into diff --git a/docs/admin/integrations/jfrog-artifactory.md b/docs/admin/integrations/jfrog-artifactory.md index 45beb743b33..98475948856 100644 --- a/docs/admin/integrations/jfrog-artifactory.md +++ b/docs/admin/integrations/jfrog-artifactory.md @@ -1,4 +1,6 @@ -# JFrog Artifactory Integration +--- +title: JFrog Artifactory Integration +--- Use Coder and JFrog Artifactory together to secure your development environments without disturbing your developers' existing workflows. diff --git a/docs/admin/integrations/kubernetes-logs.md b/docs/admin/integrations/kubernetes-logs.md index d4794f8c587..ac1a55f410c 100644 --- a/docs/admin/integrations/kubernetes-logs.md +++ b/docs/admin/integrations/kubernetes-logs.md @@ -1,4 +1,6 @@ -# Kubernetes event logs +--- +title: Kubernetes event logs +--- To stream Kubernetes events into your workspace startup logs, you can use Coder's [`coder-logstream-kube`](https://github.com/coder/coder-logstream-kube) diff --git a/docs/admin/integrations/multiple-kube-clusters.md b/docs/admin/integrations/multiple-kube-clusters.md index 3bbea893f96..3d9fac37497 100644 --- a/docs/admin/integrations/multiple-kube-clusters.md +++ b/docs/admin/integrations/multiple-kube-clusters.md @@ -1,4 +1,6 @@ -# Additional clusters +--- +title: Additional clusters +--- With Coder, you can deploy workspaces in additional Kubernetes clusters using different diff --git a/docs/admin/integrations/oauth2-provider.md b/docs/admin/integrations/oauth2-provider.md index 51c588e513c..a4f5062b209 100644 --- a/docs/admin/integrations/oauth2-provider.md +++ b/docs/admin/integrations/oauth2-provider.md @@ -1,4 +1,6 @@ -# OAuth2 Provider (Experimental) +--- +title: OAuth2 Provider (Experimental) +--- > [!WARNING] > The OAuth2 provider functionality is currently **experimental and unstable**. This feature: diff --git a/docs/admin/integrations/vault.md b/docs/admin/integrations/vault.md index a492d84411f..f0bc2f7d648 100644 --- a/docs/admin/integrations/vault.md +++ b/docs/admin/integrations/vault.md @@ -1,4 +1,6 @@ -# Integrating HashiCorp Vault with Coder +--- +title: Integrating HashiCorp Vault with Coder +---
diff --git a/docs/admin/monitoring/connection-logs.md b/docs/admin/monitoring/connection-logs.md index 6f023cf747a..cbd9f4b48ca 100644 --- a/docs/admin/monitoring/connection-logs.md +++ b/docs/admin/monitoring/connection-logs.md @@ -1,4 +1,6 @@ -# Connection Logs (Premium) +--- +title: Connection Logs (Premium) +--- > [!NOTE] > Connection logs require a diff --git a/docs/admin/monitoring/health-check.md b/docs/admin/monitoring/health-check.md index ecd2760b53b..bd3e58209c2 100644 --- a/docs/admin/monitoring/health-check.md +++ b/docs/admin/monitoring/health-check.md @@ -1,4 +1,6 @@ -# Deployment Health +--- +title: Deployment Health +--- Coder includes an operator-friendly deployment health page that provides a number of details about the health of your Coder deployment. diff --git a/docs/admin/monitoring/index.md b/docs/admin/monitoring/index.md index 61e27e79306..881e71ebc2a 100644 --- a/docs/admin/monitoring/index.md +++ b/docs/admin/monitoring/index.md @@ -1,4 +1,6 @@ -# Monitoring Coder +--- +title: Monitoring Coder +--- Learn about our the tools, techniques, and best practices to monitor your Coder deployment. diff --git a/docs/admin/monitoring/metrics.md b/docs/admin/monitoring/metrics.md index 5a30076f1db..0e6c621b78d 100644 --- a/docs/admin/monitoring/metrics.md +++ b/docs/admin/monitoring/metrics.md @@ -1,4 +1,6 @@ -# Deployment Metrics +--- +title: 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 diff --git a/docs/admin/networking/wildcard-access-url.md b/docs/admin/networking/wildcard-access-url.md index 57598cc591e..4be9db07f60 100644 --- a/docs/admin/networking/wildcard-access-url.md +++ b/docs/admin/networking/wildcard-access-url.md @@ -1,4 +1,6 @@ -# Wildcard Access URLs +--- +title: Wildcard Access URLs +--- Wildcard access URLs unlock Coder's full potential for modern development workflows. While optional for basic SSH usage, this feature becomes essential when teams need web applications, development previews, or browser-based tools. **Wildcard access URLs are essential for many development workflows in Coder** - Web IDEs (code-server, VS Code Web, JupyterLab) and some development frameworks work significantly better with subdomain-based access rather than path-based URLs. diff --git a/docs/admin/networking/workspace-proxies.md b/docs/admin/networking/workspace-proxies.md index a85c6b98555..2ff33a562f7 100644 --- a/docs/admin/networking/workspace-proxies.md +++ b/docs/admin/networking/workspace-proxies.md @@ -1,4 +1,6 @@ -# Workspace Proxies (Premium) +--- +title: Workspace Proxies (Premium) +--- Workspace proxies provide low-latency experiences for geo-distributed teams. diff --git a/docs/admin/provisioners/index.md b/docs/admin/provisioners/index.md index 9f3bfb58aef..7aadb7378db 100644 --- a/docs/admin/provisioners/index.md +++ b/docs/admin/provisioners/index.md @@ -1,4 +1,6 @@ -# External provisioners +--- +title: External provisioners +--- By default, the Coder server runs [built-in provisioner daemons](../../reference/cli/server.md#--provisioner-daemons), diff --git a/docs/admin/provisioners/manage-provisioner-jobs.md b/docs/admin/provisioners/manage-provisioner-jobs.md index a01c36afb44..52e772a9fec 100644 --- a/docs/admin/provisioners/manage-provisioner-jobs.md +++ b/docs/admin/provisioners/manage-provisioner-jobs.md @@ -1,4 +1,6 @@ -# Manage provisioner jobs +--- +title: Manage provisioner jobs +--- [Provisioners](./index.md) start and run provisioner jobs to create or delete workspaces. Each time a workspace is built, rebuilt, or destroyed, it generates a new job and assigns diff --git a/docs/admin/setup/appearance.md b/docs/admin/setup/appearance.md index 62b2042dfd3..b253f9315d1 100644 --- a/docs/admin/setup/appearance.md +++ b/docs/admin/setup/appearance.md @@ -1,4 +1,6 @@ -# Appearance (Premium) +--- +title: Appearance (Premium) +--- > [!NOTE] > Customizing Coder's appearance is a Premium feature. diff --git a/docs/admin/setup/chat-lifecycle-hooks.md b/docs/admin/setup/chat-lifecycle-hooks.md index 5bdbf17c6be..eb574ab639c 100644 --- a/docs/admin/setup/chat-lifecycle-hooks.md +++ b/docs/admin/setup/chat-lifecycle-hooks.md @@ -1,4 +1,6 @@ -# Configure chat lifecycle hooks +--- +title: Configure chat lifecycle hooks +--- > [!NOTE] > Chat lifecycle hooks are an experimental feature. diff --git a/docs/admin/setup/index.md b/docs/admin/setup/index.md index a2c4fe776d3..bd440f15f07 100644 --- a/docs/admin/setup/index.md +++ b/docs/admin/setup/index.md @@ -1,4 +1,6 @@ -# Configure Control Plane Access +--- +title: Configure Control Plane Access +--- Coder server's primary configuration is done via environment variables. For a full list of the options, run `coder server --help` or see our diff --git a/docs/admin/templates/extending-templates/agent-metadata.md b/docs/admin/templates/extending-templates/agent-metadata.md index 1c1dd0e7c2e..47563035b4b 100644 --- a/docs/admin/templates/extending-templates/agent-metadata.md +++ b/docs/admin/templates/extending-templates/agent-metadata.md @@ -1,4 +1,6 @@ -# Agent metadata +--- +title: Agent metadata +--- ![agent-metadata](../../../images/admin/templates/agent-metadata-ui.png) diff --git a/docs/admin/templates/extending-templates/environment-variables.md b/docs/admin/templates/extending-templates/environment-variables.md index 27082154f13..b7c5ae7350c 100644 --- a/docs/admin/templates/extending-templates/environment-variables.md +++ b/docs/admin/templates/extending-templates/environment-variables.md @@ -1,4 +1,6 @@ -# Environment variables +--- +title: Environment variables +--- Use the [`coder_env`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/env) diff --git a/docs/admin/templates/extending-templates/index.md b/docs/admin/templates/extending-templates/index.md index dbbca837a9f..ea611db260a 100644 --- a/docs/admin/templates/extending-templates/index.md +++ b/docs/admin/templates/extending-templates/index.md @@ -1,4 +1,6 @@ -# Extending templates +--- +title: Extending templates +--- 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 diff --git a/docs/admin/templates/extending-templates/jetbrains-airgapped.md b/docs/admin/templates/extending-templates/jetbrains-airgapped.md index ace2c92bfa3..c208829b7eb 100644 --- a/docs/admin/templates/extending-templates/jetbrains-airgapped.md +++ b/docs/admin/templates/extending-templates/jetbrains-airgapped.md @@ -1,4 +1,6 @@ -# JetBrains IDEs in an air-gapped environment +--- +title: JetBrains IDEs in an air-gapped environment +--- In networks that restrict access to the internet, you will need to leverage the JetBrains Client Installer to download and save the IDE clients locally. Please diff --git a/docs/admin/templates/extending-templates/jetbrains-preinstall.md b/docs/admin/templates/extending-templates/jetbrains-preinstall.md index 3a07e822754..db845becac6 100644 --- a/docs/admin/templates/extending-templates/jetbrains-preinstall.md +++ b/docs/admin/templates/extending-templates/jetbrains-preinstall.md @@ -1,4 +1,6 @@ -# Pre-install JetBrains IDEs in your template +--- +title: Pre-install JetBrains IDEs in your template +--- For a faster first time connection with JetBrains IDEs, pre-install the IDEs backend in your template. diff --git a/docs/admin/templates/extending-templates/modules.md b/docs/admin/templates/extending-templates/modules.md index 9dc1e8a547b..01ef0c3b256 100644 --- a/docs/admin/templates/extending-templates/modules.md +++ b/docs/admin/templates/extending-templates/modules.md @@ -1,4 +1,6 @@ -# Reusing template code +--- +title: Reusing template code +--- To reuse code across different Coder templates, such as common scripts or resource definitions, we suggest using diff --git a/docs/admin/templates/extending-templates/parameters.md b/docs/admin/templates/extending-templates/parameters.md index cf8a450f9ff..f45ec1f47c4 100644 --- a/docs/admin/templates/extending-templates/parameters.md +++ b/docs/admin/templates/extending-templates/parameters.md @@ -1,4 +1,6 @@ -# Parameters +--- +title: Parameters +--- A template can prompt the user for additional information when creating workspaces with diff --git a/docs/admin/templates/extending-templates/process-logging.md b/docs/admin/templates/extending-templates/process-logging.md index 979b371913d..423ea1b261d 100644 --- a/docs/admin/templates/extending-templates/process-logging.md +++ b/docs/admin/templates/extending-templates/process-logging.md @@ -1,4 +1,6 @@ -# Workspace Process Logging +--- +title: Workspace Process Logging +--- The workspace process logging feature allows you to log all system-level processes executing in the workspace. diff --git a/docs/admin/templates/extending-templates/resource-monitoring.md b/docs/admin/templates/extending-templates/resource-monitoring.md index 441b88f9644..2be943192ab 100644 --- a/docs/admin/templates/extending-templates/resource-monitoring.md +++ b/docs/admin/templates/extending-templates/resource-monitoring.md @@ -1,4 +1,6 @@ -# Resource monitoring +--- +title: Resource monitoring +--- Use the [`resources_monitoring`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#resources_monitoring-1) diff --git a/docs/admin/templates/extending-templates/resource-ordering.md b/docs/admin/templates/extending-templates/resource-ordering.md index c26c88f4d5a..a79a99cb523 100644 --- a/docs/admin/templates/extending-templates/resource-ordering.md +++ b/docs/admin/templates/extending-templates/resource-ordering.md @@ -1,4 +1,6 @@ -# UI Resource Ordering +--- +title: UI Resource Ordering +--- In Coder templates, managing the order of UI elements is crucial for a seamless user experience. This page outlines how resources can be aligned using the diff --git a/docs/admin/templates/extending-templates/resource-persistence.md b/docs/admin/templates/extending-templates/resource-persistence.md index a0ccbeea606..5b8cc600ffb 100644 --- a/docs/admin/templates/extending-templates/resource-persistence.md +++ b/docs/admin/templates/extending-templates/resource-persistence.md @@ -1,4 +1,6 @@ -# Resource persistence +--- +title: Resource persistence +--- By default, all Coder resources are persistent, but production templates **must** use the practices laid out in this document to prevent accidental diff --git a/docs/admin/templates/extending-templates/variables.md b/docs/admin/templates/extending-templates/variables.md index 4fa89d40aeb..30e8db41451 100644 --- a/docs/admin/templates/extending-templates/variables.md +++ b/docs/admin/templates/extending-templates/variables.md @@ -1,4 +1,6 @@ -# Terraform template-wide variables +--- +title: Terraform template-wide variables +--- In Coder, Terraform templates offer extensive flexibility through template-wide variables. These variables, managed by template authors, facilitate the diff --git a/docs/admin/templates/extending-templates/web-ides.md b/docs/admin/templates/extending-templates/web-ides.md index e87476d10e1..064555073e2 100644 --- a/docs/admin/templates/extending-templates/web-ides.md +++ b/docs/admin/templates/extending-templates/web-ides.md @@ -1,4 +1,6 @@ -# Web IDEs +--- +title: Web IDEs in templates +--- In Coder, web IDEs are defined as [coder_app](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app) diff --git a/docs/admin/templates/index.md b/docs/admin/templates/index.md index 36b2cb7d15b..d557dc981fc 100644 --- a/docs/admin/templates/index.md +++ b/docs/admin/templates/index.md @@ -1,4 +1,6 @@ -# Template +--- +title: Template +--- Templates are written in [Terraform](https://developer.hashicorp.com/terraform/intro) and define the diff --git a/docs/admin/templates/managing-templates/change-management.md b/docs/admin/templates/managing-templates/change-management.md index d7aec85ed05..d14599a7480 100644 --- a/docs/admin/templates/managing-templates/change-management.md +++ b/docs/admin/templates/managing-templates/change-management.md @@ -1,4 +1,6 @@ -# Template Change Management +--- +title: Template Change Management +--- We recommend source-controlling your templates as you would other any code, and automating the creation of new versions in CI/CD pipelines. diff --git a/docs/admin/templates/managing-templates/index.md b/docs/admin/templates/managing-templates/index.md index 413b99adc19..8f6dcdc942c 100644 --- a/docs/admin/templates/managing-templates/index.md +++ b/docs/admin/templates/managing-templates/index.md @@ -1,4 +1,6 @@ -# Working with templates +--- +title: Working with templates +--- You create and edit Coder templates as [Terraform](https://developer.hashicorp.com/terraform/intro) configuration files (`.tf`) and diff --git a/docs/admin/templates/startup-coordination/example.md b/docs/admin/templates/startup-coordination/example.md index e30a25b9238..d3937cec064 100644 --- a/docs/admin/templates/startup-coordination/example.md +++ b/docs/admin/templates/startup-coordination/example.md @@ -1,4 +1,6 @@ -# Workspace Startup Coordination Examples +--- +title: Workspace Startup Coordination Examples +--- ## Script Example diff --git a/docs/admin/templates/startup-coordination/index.md b/docs/admin/templates/startup-coordination/index.md index 694384655ee..f776addc350 100644 --- a/docs/admin/templates/startup-coordination/index.md +++ b/docs/admin/templates/startup-coordination/index.md @@ -1,4 +1,6 @@ -# Workspace Startup Coordination +--- +title: Workspace Startup Coordination +--- > [!NOTE] > This feature is experimental and may change without notice in future releases. diff --git a/docs/admin/templates/startup-coordination/troubleshooting.md b/docs/admin/templates/startup-coordination/troubleshooting.md index 5c612d191c9..57b6160ce95 100644 --- a/docs/admin/templates/startup-coordination/troubleshooting.md +++ b/docs/admin/templates/startup-coordination/troubleshooting.md @@ -1,4 +1,6 @@ -# Workspace Startup Coordination Troubleshooting +--- +title: Workspace Startup Coordination Troubleshooting +--- > [!NOTE] > This feature is experimental and may change without notice in future releases. diff --git a/docs/admin/templates/startup-coordination/usage.md b/docs/admin/templates/startup-coordination/usage.md index 03d44543805..cd47f36cb36 100644 --- a/docs/admin/templates/startup-coordination/usage.md +++ b/docs/admin/templates/startup-coordination/usage.md @@ -1,4 +1,6 @@ -# Workspace Startup Coordination Usage +--- +title: Workspace Startup Coordination Usage +--- > [!NOTE] > This feature is experimental and may change without notice in future releases. diff --git a/docs/admin/templates/template-permissions.md b/docs/admin/templates/template-permissions.md index ed77b61d9d7..c6fc72deb78 100644 --- a/docs/admin/templates/template-permissions.md +++ b/docs/admin/templates/template-permissions.md @@ -1,4 +1,6 @@ -# Permissions +--- +title: Permissions +--- > [!NOTE] > Template permissions are a Premium feature. diff --git a/docs/admin/templates/troubleshooting.md b/docs/admin/templates/troubleshooting.md index 13fe7913829..d8a8c9c62b6 100644 --- a/docs/admin/templates/troubleshooting.md +++ b/docs/admin/templates/troubleshooting.md @@ -1,4 +1,6 @@ -# Troubleshooting templates +--- +title: Troubleshooting templates +--- Occasionally, you may run into scenarios where a workspace is created, but the agent is either not connected or the diff --git a/docs/admin/users/github-auth.md b/docs/admin/users/github-auth.md index 8735f110080..d4985971181 100644 --- a/docs/admin/users/github-auth.md +++ b/docs/admin/users/github-auth.md @@ -1,4 +1,6 @@ -# GitHub +--- +title: GitHub +--- By default, new Coder deployments use a Coder-managed GitHub app to authenticate users. diff --git a/docs/admin/users/groups-roles.md b/docs/admin/users/groups-roles.md index 4c5c2966519..1daeb326fc0 100644 --- a/docs/admin/users/groups-roles.md +++ b/docs/admin/users/groups-roles.md @@ -1,4 +1,6 @@ -# Groups and Roles (Premium) +--- +title: Groups and Roles (Premium) +--- Groups and roles can be manually assigned in Coder. For production deployments, these can also be [managed and synced by the identity provider](./idp-sync.md). diff --git a/docs/admin/users/oidc-auth/google.md b/docs/admin/users/oidc-auth/google.md index 95f3c7ac2c2..68235a8c9cf 100644 --- a/docs/admin/users/oidc-auth/google.md +++ b/docs/admin/users/oidc-auth/google.md @@ -1,4 +1,6 @@ -# Google authentication (OIDC) +--- +title: Google authentication (OIDC) +--- This guide shows how to configure Coder to authenticate users with Google using OpenID Connect (OIDC). diff --git a/docs/admin/users/oidc-auth/index.md b/docs/admin/users/oidc-auth/index.md index ec31071a83e..fb6a5aa541f 100644 --- a/docs/admin/users/oidc-auth/index.md +++ b/docs/admin/users/oidc-auth/index.md @@ -1,4 +1,6 @@ -# OpenID Connect +--- +title: OpenID Connect +--- The following steps through how to integrate any OpenID Connect provider (Okta, Active Directory, etc.) to Coder. diff --git a/docs/admin/users/oidc-auth/microsoft.md b/docs/admin/users/oidc-auth/microsoft.md index 2fae3fbc464..c9883507fb8 100644 --- a/docs/admin/users/oidc-auth/microsoft.md +++ b/docs/admin/users/oidc-auth/microsoft.md @@ -1,4 +1,6 @@ -# Microsoft Entra ID authentication (OIDC) +--- +title: Microsoft Entra ID authentication (OIDC) +--- This guide shows how to configure Coder to authenticate users with Microsoft Entra ID using OpenID Connect (OIDC) diff --git a/docs/admin/users/organizations.md b/docs/admin/users/organizations.md index a5d9fe9cc4c..434ed0d3c68 100644 --- a/docs/admin/users/organizations.md +++ b/docs/admin/users/organizations.md @@ -1,4 +1,6 @@ -# Organizations (Premium) +--- +title: Organizations (Premium) +--- > [!NOTE] > Organizations requires a diff --git a/docs/admin/users/sessions-tokens.md b/docs/admin/users/sessions-tokens.md index f07e4e44746..7f9c6668496 100644 --- a/docs/admin/users/sessions-tokens.md +++ b/docs/admin/users/sessions-tokens.md @@ -1,4 +1,6 @@ -# API & Session Tokens +--- +title: API & Session Tokens +--- Users can generate tokens to make API requests on behalf of themselves. diff --git a/docs/ai-coder/agent-compatibility.md b/docs/ai-coder/agent-compatibility.md index 17a540647cf..599c9c89fc3 100644 --- a/docs/ai-coder/agent-compatibility.md +++ b/docs/ai-coder/agent-compatibility.md @@ -1,4 +1,6 @@ -# Agent compatibility +--- +title: Agent compatibility +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/agent-firewall/landjail.md b/docs/ai-coder/agent-firewall/landjail.md index 4c0a397d00f..fb70b5aeaa2 100644 --- a/docs/ai-coder/agent-firewall/landjail.md +++ b/docs/ai-coder/agent-firewall/landjail.md @@ -1,4 +1,6 @@ -# landjail Jail Type +--- +title: landjail Jail Type +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/nsjail/docker.md b/docs/ai-coder/agent-firewall/nsjail/docker.md index 33e0b67ceba..7652a65e1ab 100644 --- a/docs/ai-coder/agent-firewall/nsjail/docker.md +++ b/docs/ai-coder/agent-firewall/nsjail/docker.md @@ -1,4 +1,6 @@ -# nsjail on Docker +--- +title: nsjail on Docker +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/nsjail/ecs.md b/docs/ai-coder/agent-firewall/nsjail/ecs.md index f5eac41a63c..1ea0b9698bd 100644 --- a/docs/ai-coder/agent-firewall/nsjail/ecs.md +++ b/docs/ai-coder/agent-firewall/nsjail/ecs.md @@ -1,4 +1,6 @@ -# nsjail on ECS +--- +title: nsjail on ECS +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/nsjail/index.md b/docs/ai-coder/agent-firewall/nsjail/index.md index 40836b21ecb..c8b5a15eb67 100644 --- a/docs/ai-coder/agent-firewall/nsjail/index.md +++ b/docs/ai-coder/agent-firewall/nsjail/index.md @@ -1,4 +1,6 @@ -# nsjail Jail Type +--- +title: nsjail Jail Type +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/nsjail/k8s.md b/docs/ai-coder/agent-firewall/nsjail/k8s.md index f4bf2db8311..c9bc49ea0de 100644 --- a/docs/ai-coder/agent-firewall/nsjail/k8s.md +++ b/docs/ai-coder/agent-firewall/nsjail/k8s.md @@ -1,4 +1,6 @@ -# nsjail on Kubernetes +--- +title: nsjail on Kubernetes +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/rules-engine.md b/docs/ai-coder/agent-firewall/rules-engine.md index 720a2599dc7..c45c37804fc 100644 --- a/docs/ai-coder/agent-firewall/rules-engine.md +++ b/docs/ai-coder/agent-firewall/rules-engine.md @@ -1,4 +1,6 @@ -# Rules Engine Documentation +--- +title: Rules Engine Documentation +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/agent-firewall/version.md b/docs/ai-coder/agent-firewall/version.md index 5b3ad22e53d..513d5086ae0 100644 --- a/docs/ai-coder/agent-firewall/version.md +++ b/docs/ai-coder/agent-firewall/version.md @@ -1,4 +1,6 @@ -# Version Requirements +--- +title: Version Requirements +--- > [!NOTE] > Agent Firewall is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/agents/chat-search-syntax.md b/docs/ai-coder/agents/chat-search-syntax.md index 4551c2fd253..7776f17f813 100644 --- a/docs/ai-coder/agents/chat-search-syntax.md +++ b/docs/ai-coder/agents/chat-search-syntax.md @@ -1,4 +1,6 @@ -# Conversation Search Syntax +--- +title: Conversation Search Syntax +--- The chat list endpoint accepts a `q` query parameter for filtering conversations. All filters use `key:value` syntax. Bare search terms diff --git a/docs/ai-coder/agents/platform-controls/chat-auto-archive.md b/docs/ai-coder/agents/platform-controls/chat-auto-archive.md index 69f83441afb..2187656ce5a 100644 --- a/docs/ai-coder/agents/platform-controls/chat-auto-archive.md +++ b/docs/ai-coder/agents/platform-controls/chat-auto-archive.md @@ -1,4 +1,6 @@ -# Conversation Auto-Archive +--- +title: Conversation Auto-Archive +--- Coder Agents automatically archives long-inactive conversations so they drop out of active chat lists without any user intervention. Archived diff --git a/docs/ai-coder/agents/platform-controls/chat-debug-retention.md b/docs/ai-coder/agents/platform-controls/chat-debug-retention.md index d5504dab5cb..e9c163a9fb9 100644 --- a/docs/ai-coder/agents/platform-controls/chat-debug-retention.md +++ b/docs/ai-coder/agents/platform-controls/chat-debug-retention.md @@ -1,4 +1,6 @@ -# Chat Debug Data Retention +--- +title: Chat Debug Data Retention +--- Coder Agents automatically cleans up old chat debug data to manage database growth. Debug data includes persisted debug runs and their associated debug diff --git a/docs/ai-coder/agents/platform-controls/chat-retention.md b/docs/ai-coder/agents/platform-controls/chat-retention.md index e28d6fe70a7..eb9f28e632a 100644 --- a/docs/ai-coder/agents/platform-controls/chat-retention.md +++ b/docs/ai-coder/agents/platform-controls/chat-retention.md @@ -1,4 +1,6 @@ -# Conversation Data Retention +--- +title: Conversation Data Retention +--- Coder Agents automatically cleans up old conversation data to manage database growth. Archived conversations and their associated files are periodically diff --git a/docs/ai-coder/agents/platform-controls/spend-management.md b/docs/ai-coder/agents/platform-controls/spend-management.md index a2ae8b825b9..6a6c4ca1bcb 100644 --- a/docs/ai-coder/agents/platform-controls/spend-management.md +++ b/docs/ai-coder/agents/platform-controls/spend-management.md @@ -1,4 +1,6 @@ -# Spend management (Premium) +--- +title: Spend management (Premium) +--- Coder controls agent spend with AI Gateway budgets, and surfaces the resulting spend to both admins and users. diff --git a/docs/ai-coder/agents/tasks-to-chats-migration.md b/docs/ai-coder/agents/tasks-to-chats-migration.md index d34fc61ae73..a0d72a571e7 100644 --- a/docs/ai-coder/agents/tasks-to-chats-migration.md +++ b/docs/ai-coder/agents/tasks-to-chats-migration.md @@ -1,4 +1,6 @@ -# Migrating from the Tasks API to the Chats API +--- +title: Migrating from the Tasks API to the Chats API +--- The [Tasks API](../../reference/api/tasks.md) (`/api/v2/tasks`) and the [Chats API](../../reference/api/chats.md) (`/api/v2/chats`) serve similar diff --git a/docs/ai-coder/ai-gateway/clients/codex.md b/docs/ai-coder/ai-gateway/clients/codex.md index 5efe33dc12e..ecdbcc5e7bb 100644 --- a/docs/ai-coder/ai-gateway/clients/codex.md +++ b/docs/ai-coder/ai-gateway/clients/codex.md @@ -1,4 +1,6 @@ -# Codex CLI +--- +title: Codex CLI +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/jetbrains.md b/docs/ai-coder/ai-gateway/clients/jetbrains.md index 45f48a41a45..608b1a2c4a2 100644 --- a/docs/ai-coder/ai-gateway/clients/jetbrains.md +++ b/docs/ai-coder/ai-gateway/clients/jetbrains.md @@ -1,4 +1,6 @@ -# JetBrains IDEs +--- +title: JetBrains +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/mcp.md b/docs/ai-coder/ai-gateway/mcp.md index 5ea0531c5be..f9d0e932719 100644 --- a/docs/ai-coder/ai-gateway/mcp.md +++ b/docs/ai-coder/ai-gateway/mcp.md @@ -1,4 +1,6 @@ -# MCP +--- +title: MCP +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is @@ -71,7 +73,7 @@ If you have [Coder MCP Server](../mcp-server.md) enabled, as well as have `CODER ### Troubleshooting -- **Too many tools**: should you receive an error like `Invalid 'tools': array too long. Expected an array with maximum length 128, but got an array with length 132 instead`, you can reduce the number by filtering out tools using the allow/deny patterns documented in the [MCP](#mcp) section. +- **Too many tools**: should you receive an error like `Invalid 'tools': array too long. Expected an array with maximum length 128, but got an array with length 132 instead`, you can reduce the number by filtering out tools using the allow/deny patterns documented above. - **Coder MCP tools not being injected**: in order for Coder MCP tools to be injected, the internal MCP server needs to be active. Follow the instructions in the [MCP Server](../mcp-server.md) page to enable it and ensure `CODER_AI_GATEWAY_INJECT_CODER_MCP_TOOLS` is set to `true`. diff --git a/docs/ai-coder/ai-gateway/standalone.md b/docs/ai-coder/ai-gateway/standalone.md index 08fe70c4e60..02b68e2f57f 100644 --- a/docs/ai-coder/ai-gateway/standalone.md +++ b/docs/ai-coder/ai-gateway/standalone.md @@ -1,4 +1,6 @@ -# Deploy AI Gateway as a standalone service +--- +title: Deploy AI Gateway as a standalone service +--- > [!NOTE] > AI Gateway requires the [AI Governance Add-On](../ai-governance.md). diff --git a/docs/ai-coder/github-to-tasks.md b/docs/ai-coder/github-to-tasks.md index f75dbe85030..8af51da508a 100644 --- a/docs/ai-coder/github-to-tasks.md +++ b/docs/ai-coder/github-to-tasks.md @@ -1,4 +1,6 @@ -# Guide: Create a GitHub to Coder Tasks Workflow +--- +title: "Guide: Create a GitHub to Coder Tasks Workflow" +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/tasks-lifecycle.md b/docs/ai-coder/tasks-lifecycle.md index 508e476a62d..3980ff94bf2 100644 --- a/docs/ai-coder/tasks-lifecycle.md +++ b/docs/ai-coder/tasks-lifecycle.md @@ -1,4 +1,6 @@ -# Task lifecycle +--- +title: Task lifecycle +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/tasks-migration.md b/docs/ai-coder/tasks-migration.md index 7fe2a01e266..e21d2287c5d 100644 --- a/docs/ai-coder/tasks-migration.md +++ b/docs/ai-coder/tasks-migration.md @@ -1,4 +1,6 @@ -# Migrating Task Templates for Coder version 2.28.0 +--- +title: Migrating Task Templates for Coder version 2.28.0 +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/get-started/customize-your-template/add-a-language.md b/docs/get-started/customize-your-template/add-a-language.md index cd047ce0721..96e6235c14d 100644 --- a/docs/get-started/customize-your-template/add-a-language.md +++ b/docs/get-started/customize-your-template/add-a-language.md @@ -1,4 +1,6 @@ -# Add a programming language to your template +--- +title: Add a programming language to your template +--- Now that you've finished [Launch your first workspace](../index.md), you can add another language toolchain to every workspace you create. diff --git a/docs/get-started/index.md b/docs/get-started/index.md index f81ae6aff2b..5b317e6d935 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -1,4 +1,6 @@ -# Quickstart +--- +title: Quickstart +--- Follow this guide to get your first Coder development environment running in under 10 minutes. This guide covers the essential concepts and shows diff --git a/docs/install/cli.md b/docs/install/cli.md index a8e5429143c..dd6a6633ee7 100644 --- a/docs/install/cli.md +++ b/docs/install/cli.md @@ -1,4 +1,6 @@ -# Installing Coder +--- +title: Install the Coder CLI +--- A single CLI (`coder`) is used for both the Coder server and the client. diff --git a/docs/install/cloud/aws-marketplace.md b/docs/install/cloud/aws-marketplace.md index 6fa8289d0bf..a83868aff22 100644 --- a/docs/install/cloud/aws-marketplace.md +++ b/docs/install/cloud/aws-marketplace.md @@ -1,4 +1,6 @@ -# Amazon Web Services +--- +title: Amazon Web Services +--- This guide is designed to get you up and running with a Coder proof-of-concept on AWS EKS using a [Coder-provided CloudFormation Template](https://codermktplc-assets.s3.us-east-1.amazonaws.com/community-edition/eks-cluster.yaml). The deployed AWS Coder Reference Architecture is below: diff --git a/docs/install/cloud/azure-vm.md b/docs/install/cloud/azure-vm.md index 258e47307ec..7912c2d8e65 100644 --- a/docs/install/cloud/azure-vm.md +++ b/docs/install/cloud/azure-vm.md @@ -1,4 +1,6 @@ -# Microsoft Azure +--- +title: Microsoft Azure +--- This guide shows you how to set up the Coder server on Azure which will provision Azure-hosted Linux workspaces. diff --git a/docs/install/cloud/compute-engine.md b/docs/install/cloud/compute-engine.md index 43c21510e5f..c24a341c7b5 100644 --- a/docs/install/cloud/compute-engine.md +++ b/docs/install/cloud/compute-engine.md @@ -1,4 +1,6 @@ -# Google Cloud Platform +--- +title: Google Cloud Platform +--- In this guide, you will learn how to deploy the Coder control plane instance and your first template. diff --git a/docs/install/cloud/index.md b/docs/install/cloud/index.md index 6271fe9b85a..6ad7bc3e2a4 100644 --- a/docs/install/cloud/index.md +++ b/docs/install/cloud/index.md @@ -1,4 +1,6 @@ -# Cloud Platforms +--- +title: Cloud Platforms +--- We provide install guides and example templates for deploying Coder to your cloud of choice. diff --git a/docs/install/docker.md b/docs/install/docker.md index 911c3484efc..c7f6cbe9d8b 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -1,4 +1,6 @@ -# Install Coder via Docker +--- +title: Install Coder via Docker +--- You can install and run Coder using the official Docker images published on [GitHub Container Registry](https://github.com/coder/coder/pkgs/container/coder). diff --git a/docs/install/index.md b/docs/install/index.md index e78cea240e1..e0da8b061e1 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,4 +1,6 @@ -# Installing Coder +--- +title: Installing Coder +--- A single CLI (`coder`) is used for both the Coder server and the client. diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md index c75a60f54fe..07abcb36777 100644 --- a/docs/install/kubernetes.md +++ b/docs/install/kubernetes.md @@ -1,4 +1,6 @@ -# Install Coder on Kubernetes +--- +title: Install Coder on Kubernetes +--- You can install Coder on Kubernetes (K8s) using Helm. We run on most Kubernetes distributions, including [OpenShift](./openshift.md). diff --git a/docs/install/other/index.md b/docs/install/other/index.md index 1aa6d195bcd..9c3a9d04f53 100644 --- a/docs/install/other/index.md +++ b/docs/install/other/index.md @@ -1,4 +1,6 @@ -# Alternate install methods +--- +title: Alternate install methods +--- Coder has a number of alternate unofficial installation methods. Contributions are welcome! diff --git a/docs/install/rancher.md b/docs/install/rancher.md index b4a58dbe1e2..5fdc36af4eb 100644 --- a/docs/install/rancher.md +++ b/docs/install/rancher.md @@ -1,4 +1,6 @@ -# Deploy Coder on Rancher +--- +title: Deploy Coder on Rancher +--- You can deploy Coder on Rancher as a [Workload](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-workloads/workload-ingress). diff --git a/docs/install/registry-mirror-artifactory.md b/docs/install/registry-mirror-artifactory.md index efd6ebc5ae8..cf5a0b5de01 100644 --- a/docs/install/registry-mirror-artifactory.md +++ b/docs/install/registry-mirror-artifactory.md @@ -1,4 +1,6 @@ -# Mirror the Coder Registry with JFrog Artifactory +--- +title: Mirror the Coder Registry with JFrog Artifactory +--- This guide shows you how to use JFrog Artifactory to mirror the [Coder Registry](https://registry.coder.com) for air-gapped or restricted diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md index df17ba0ec25..2f5260e2c82 100644 --- a/docs/install/upgrade.md +++ b/docs/install/upgrade.md @@ -1,4 +1,6 @@ -# Upgrade +--- +title: Upgrade +--- This article describes how to upgrade your Coder server. diff --git a/docs/reference/agent-api/index.md b/docs/reference/agent-api/index.md index e6ca3b4626a..b0b9f417160 100644 --- a/docs/reference/agent-api/index.md +++ b/docs/reference/agent-api/index.md @@ -1,4 +1,6 @@ -# Sections +--- +title: Sections +--- This page is rendered on https://coder.com/docs/reference/agent-api. Refer to the other documents in the `agent-api/` directory. diff --git a/docs/support/support-bundle.md b/docs/support/support-bundle.md index 4d7e2750eaa..55354faf5e2 100644 --- a/docs/support/support-bundle.md +++ b/docs/support/support-bundle.md @@ -1,4 +1,6 @@ -# Generate and upload a Support Bundle to Coder Support +--- +title: Generate and upload a Support Bundle to Coder Support +--- When you engage with Coder support to diagnose an issue with your deployment, you may be asked to generate and upload a "Support Bundle" for offline analysis. diff --git a/docs/tutorials/azure-federation.md b/docs/tutorials/azure-federation.md index 0ac02495dbe..0fe1af7313e 100644 --- a/docs/tutorials/azure-federation.md +++ b/docs/tutorials/azure-federation.md @@ -1,4 +1,6 @@ -# Federating Coder's control plane to Azure +--- +title: Federating Coder's control plane to Azure +---
diff --git a/docs/tutorials/best-practices/scale-coder.md b/docs/tutorials/best-practices/scale-coder.md index 87e3c3ced38..bdf62f749fe 100644 --- a/docs/tutorials/best-practices/scale-coder.md +++ b/docs/tutorials/best-practices/scale-coder.md @@ -1,4 +1,6 @@ -# Scale Coder +--- +title: Scale Coder +--- This best practice guide helps you prepare a Coder deployment that you can scale up to a high-scale deployment as use grows, and keep it operating smoothly with a diff --git a/docs/tutorials/best-practices/speed-up-templates.md b/docs/tutorials/best-practices/speed-up-templates.md index bb9d736d945..566f64b5797 100644 --- a/docs/tutorials/best-practices/speed-up-templates.md +++ b/docs/tutorials/best-practices/speed-up-templates.md @@ -1,4 +1,6 @@ -# Speed up your Coder templates and workspaces +--- +title: Speed up your Coder templates and workspaces +--- October 31, 2024 diff --git a/docs/tutorials/configuring-okta.md b/docs/tutorials/configuring-okta.md index 112eec8bb59..da7039b02db 100644 --- a/docs/tutorials/configuring-okta.md +++ b/docs/tutorials/configuring-okta.md @@ -1,4 +1,6 @@ -# Configuring Custom Claims/Scopes with Okta for group/role +--- +title: Configuring Custom Claims/Scopes with Okta for group/role +---
Author: diff --git a/docs/tutorials/external-database.md b/docs/tutorials/external-database.md index dda44b90829..028b1ab81dd 100644 --- a/docs/tutorials/external-database.md +++ b/docs/tutorials/external-database.md @@ -1,4 +1,6 @@ -# Using Coder with an external database +--- +title: Using Coder with an external database +--- ## Recommendation diff --git a/docs/tutorials/gcp-to-aws.md b/docs/tutorials/gcp-to-aws.md index c1e767494ed..dd705a51d68 100644 --- a/docs/tutorials/gcp-to-aws.md +++ b/docs/tutorials/gcp-to-aws.md @@ -1,4 +1,6 @@ -# Federating a Google Cloud service account to AWS +--- +title: Federating a Google Cloud service account to AWS +---
diff --git a/docs/tutorials/image-pull-secret.md b/docs/tutorials/image-pull-secret.md index a8802bf2f2c..7c3da4bda88 100644 --- a/docs/tutorials/image-pull-secret.md +++ b/docs/tutorials/image-pull-secret.md @@ -1,4 +1,6 @@ -# Defining ImagePullSecrets for Coder workspaces +--- +title: Defining ImagePullSecrets for Coder workspaces +---
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 0e75ce50ab2..56ae51de529 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -1,4 +1,6 @@ -# Guides and Tutorials +--- +title: Guides and Tutorials +--- Here you can find a list of employee-written guides on Coder. These tutorials are hosted on our [GitHub](https://github.com/coder/coder/) where you can leave diff --git a/docs/tutorials/persistent-shared-workspaces.md b/docs/tutorials/persistent-shared-workspaces.md index cbd28587bf7..7925fd7f0e7 100644 --- a/docs/tutorials/persistent-shared-workspaces.md +++ b/docs/tutorials/persistent-shared-workspaces.md @@ -1,4 +1,6 @@ -# Persistent Shared Workspaces with Service Accounts +--- +title: Persistent Shared Workspaces with Service Accounts +--- > [!NOTE] > This guide requires a diff --git a/docs/tutorials/postgres-ssl.md b/docs/tutorials/postgres-ssl.md index 027982b7618..15753d4f6d4 100644 --- a/docs/tutorials/postgres-ssl.md +++ b/docs/tutorials/postgres-ssl.md @@ -1,4 +1,6 @@ -# Configure Coder to connect to PostgreSQL using SSL +--- +title: Configure Coder to connect to PostgreSQL using SSL +---
diff --git a/docs/tutorials/reverse-proxy-apache.md b/docs/tutorials/reverse-proxy-apache.md index 027d289892b..c2669276aeb 100644 --- a/docs/tutorials/reverse-proxy-apache.md +++ b/docs/tutorials/reverse-proxy-apache.md @@ -1,4 +1,6 @@ -# How to use Apache as a reverse-proxy with LetsEncrypt +--- +title: How to use Apache as a reverse-proxy with LetsEncrypt +--- ## Requirements diff --git a/docs/tutorials/reverse-proxy-caddy.md b/docs/tutorials/reverse-proxy-caddy.md index 1b83fd9fd0f..0ada97fb2f6 100644 --- a/docs/tutorials/reverse-proxy-caddy.md +++ b/docs/tutorials/reverse-proxy-caddy.md @@ -1,4 +1,6 @@ -# Caddy +--- +title: Caddy +--- This is an example configuration of how to use Coder with [caddy](https://caddyserver.com/docs). To use Caddy to generate TLS diff --git a/docs/tutorials/reverse-proxy-nginx.md b/docs/tutorials/reverse-proxy-nginx.md index c6053a8de9a..9bdc42cbae0 100644 --- a/docs/tutorials/reverse-proxy-nginx.md +++ b/docs/tutorials/reverse-proxy-nginx.md @@ -1,4 +1,6 @@ -# How to use NGINX as a reverse-proxy with LetsEncrypt +--- +title: How to use NGINX as a reverse-proxy with LetsEncrypt +--- ## Requirements diff --git a/docs/tutorials/template-from-scratch.md b/docs/tutorials/template-from-scratch.md index 85f64f8f592..e9a2c936be7 100644 --- a/docs/tutorials/template-from-scratch.md +++ b/docs/tutorials/template-from-scratch.md @@ -1,4 +1,6 @@ -# Write a template from scratch +--- +title: Write a template from scratch +--- > [!TIP] > If you want to create a template without writing Terraform, use the diff --git a/docs/tutorials/testing-templates.md b/docs/tutorials/testing-templates.md index 00e5b29e94e..3e53abce443 100644 --- a/docs/tutorials/testing-templates.md +++ b/docs/tutorials/testing-templates.md @@ -1,4 +1,6 @@ -# Test and Publish Coder Templates Through CI/CD +--- +title: Test and Publish Coder Templates Through CI/CD +---
diff --git a/docs/user-guides/devcontainers/working-with-dev-containers.md b/docs/user-guides/devcontainers/working-with-dev-containers.md index c77bc0e61cf..7e5d547e643 100644 --- a/docs/user-guides/devcontainers/working-with-dev-containers.md +++ b/docs/user-guides/devcontainers/working-with-dev-containers.md @@ -1,4 +1,6 @@ -# Working with Dev Containers +--- +title: Working with Dev Containers +--- The dev container integration appears in your Coder dashboard, providing a visual representation of the running environment: diff --git a/docs/user-guides/shared-workspaces.md b/docs/user-guides/shared-workspaces.md index 02a3ae75f4b..ba0bc791586 100644 --- a/docs/user-guides/shared-workspaces.md +++ b/docs/user-guides/shared-workspaces.md @@ -1,4 +1,6 @@ -# Shared Workspaces +--- +title: Shared Workspaces +--- Multiple users can securely connect to a single Coder workspace for programming and debugging. diff --git a/docs/user-guides/workspace-access/filebrowser.md b/docs/user-guides/workspace-access/filebrowser.md index c911f4bcf2c..7e9a0ca29c0 100644 --- a/docs/user-guides/workspace-access/filebrowser.md +++ b/docs/user-guides/workspace-access/filebrowser.md @@ -1,4 +1,6 @@ -# File Browser +--- +title: File Browser +--- File Browser is a file manager for the web that can be used to upload, download, and view files in your workspace. A template administrator can add it by diff --git a/docs/user-guides/workspace-access/index.md b/docs/user-guides/workspace-access/index.md index 722094ce2f6..6915c62f676 100644 --- a/docs/user-guides/workspace-access/index.md +++ b/docs/user-guides/workspace-access/index.md @@ -1,4 +1,6 @@ -# Access your workspace +--- +title: Access your workspace +--- There are many ways to connect to your workspace, the options are only limited by the template configuration. diff --git a/docs/user-guides/workspace-access/jetbrains/toolbox.md b/docs/user-guides/workspace-access/jetbrains/toolbox.md index 49d67335fd9..db76761f8bf 100644 --- a/docs/user-guides/workspace-access/jetbrains/toolbox.md +++ b/docs/user-guides/workspace-access/jetbrains/toolbox.md @@ -1,4 +1,6 @@ -# JetBrains Toolbox (beta) +--- +title: JetBrains Toolbox (beta) +--- JetBrains Toolbox helps you manage JetBrains products and includes remote development capabilities for connecting to Coder workspaces. diff --git a/docs/user-guides/workspace-access/port-forwarding.md b/docs/user-guides/workspace-access/port-forwarding.md index 26843bcb936..0f1b68adaf7 100644 --- a/docs/user-guides/workspace-access/port-forwarding.md +++ b/docs/user-guides/workspace-access/port-forwarding.md @@ -1,4 +1,6 @@ -# Workspace Ports +--- +title: Workspace Ports +--- ## Port forwarding diff --git a/docs/user-guides/workspace-access/remote-desktops.md b/docs/user-guides/workspace-access/remote-desktops.md index e3c8bfa77cf..98755c3f3b1 100644 --- a/docs/user-guides/workspace-access/remote-desktops.md +++ b/docs/user-guides/workspace-access/remote-desktops.md @@ -1,4 +1,6 @@ -# Remote Desktops +--- +title: Remote Desktops +--- ## RDP diff --git a/docs/user-guides/workspace-access/web-ides.md b/docs/user-guides/workspace-access/web-ides.md index 5505f81a4c7..fa09a286c62 100644 --- a/docs/user-guides/workspace-access/web-ides.md +++ b/docs/user-guides/workspace-access/web-ides.md @@ -1,4 +1,6 @@ -# Web IDEs +--- +title: Web IDEs +--- By default, Coder workspaces allow connections via: diff --git a/docs/user-guides/workspace-lifecycle.md b/docs/user-guides/workspace-lifecycle.md index bad631b6dc7..8bbdf4ed6f0 100644 --- a/docs/user-guides/workspace-lifecycle.md +++ b/docs/user-guides/workspace-lifecycle.md @@ -1,4 +1,6 @@ -# Workspace lifecycle +--- +title: Workspace lifecycle +--- Workspaces are flexible, reproducible, and isolated units of compute. Workspaces are created via Terraform, managed through the Coder control plane, accessed diff --git a/docs/user-guides/workspace-management.md b/docs/user-guides/workspace-management.md index 013b0a29ab8..ca1996b8874 100644 --- a/docs/user-guides/workspace-management.md +++ b/docs/user-guides/workspace-management.md @@ -1,4 +1,6 @@ -# Workspaces +--- +title: Manage workspaces +--- A workspace is the environment that a developer works in. Developers in a team each work from their own workspace and can use diff --git a/docs/user-guides/workspace-scheduling.md b/docs/user-guides/workspace-scheduling.md index d1188bbd757..9e75696d161 100644 --- a/docs/user-guides/workspace-scheduling.md +++ b/docs/user-guides/workspace-scheduling.md @@ -1,4 +1,6 @@ -# Managing workspace schedules +--- +title: Managing workspace schedules +--- Scheduling helps minimize cloud costs without sacrificing the availability of your workspaces. From c92b1f3e334ee7b38bd5c674ef0157e1c05402d8 Mon Sep 17 00:00:00 2001 From: Nick Vigilante Date: Tue, 11 Aug 2026 19:55:17 +0000 Subject: [PATCH 2/2] docs: retitle install landing page per docs owner Set the install landing page title to "Install Coder in your infrastructure" (sidebar label unchanged). --- docs/install/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/index.md b/docs/install/index.md index e0da8b061e1..36c11fb44ba 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,5 +1,5 @@ --- -title: Installing Coder +title: Install Coder in your infrastructure --- A single CLI (`coder`) is used for both the Coder server and the client.