Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# About
---
title: About
---

<!-- Warning for docs contributors: The first route in manifest.json must be titled "About" for the static landing page to work correctly. -->

Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/AI_CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# AI Contribution Guidelines
---
title: AI Contribution Guidelines
---

This document defines rules for contributions where an AI system is the primary author of the code (i.e., most of the pull request was generated by AI).
It applies to all Coder repositories and is a supplement to the [existing contributing guidelines](./CONTRIBUTING.md), not a replacement.
Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Contributing
---
title: Contributing
---

## Requirements

Expand Down Expand Up @@ -91,7 +93,7 @@
`pre-push` is skipped entirely. Changes to Go, TypeScript, SQL, proto, or
the Makefile trigger the full targets as before.

### Running Coder on development mode

Check warning on line 96 in docs/about/contributing/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. Run the development script to spin up the local environment:

Expand Down Expand Up @@ -129,7 +131,7 @@
./scripts/coder-dev.sh create my-workspace -t docker
```

### Deploying a PR

Check warning on line 134 in docs/about/contributing/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Deploying'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

You need to be a member or collaborator of the [coder](https://github.com/coder) GitHub organization to be able to deploy a PR.

Expand Down Expand Up @@ -258,7 +260,7 @@
The workflow validates that commits are on the expected branch for each release
type.

### Retrying a failed release

Check warning on line 263 in docs/about/contributing/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Retrying'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

If the
[`release.yaml`](https://github.com/coder/coder/actions/workflows/release.yaml)
Expand Down Expand Up @@ -300,7 +302,7 @@
formatted title. Take care when merging single-commit PRs as GitHub may prefer
to use the original commit title instead of the PR title.

### Backporting fixes to release branches

Check warning on line 305 in docs/about/contributing/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Backporting'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

When a merged PR on `main` should also ship in older releases, add the
`backport` label to the PR. The
Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/backend.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Backend
---
title: Backend
---

This guide is designed to support both Coder engineers and community contributors in understanding our backend systems and getting started with development.

Expand Down Expand Up @@ -86,7 +88,7 @@
* [tailnet](../../../tailnet): core logic of Tailnet controller to maintain DERP maps, coordinate connections with agents and peers
* [vpn](../../../vpn): Coder Desktop (VPN) and tunneling components

## Testing

Check warning on line 91 in docs/about/contributing/backend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Testing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

The Coder backend includes a rich suite of unit and end-to-end tests. A variety of helper utilities are used throughout the codebase to make testing easier, more consistent, and closer to real behavior.

Expand Down Expand Up @@ -142,7 +144,7 @@

## Recipes

### Adding database migrations and fixtures

Check warning on line 147 in docs/about/contributing/backend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Adding'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

#### Database migrations

Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/documentation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Documentation
---
title: Documentation
---

This style guide is primarily for use with authoring documentation.

Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/frontend.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Frontend
---
title: Frontend
---

Welcome to the guide for contributing to the Coder frontend. Whether you’re part
of the community or a Coder team member, this documentation will help you get
Expand All @@ -8,7 +10,7 @@
[Discord server](https://discord.com/invite/coder), and we’ll be happy to assist
you.

## Running the UI

Check warning on line 13 in docs/about/contributing/frontend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

You can run the UI and access the Coder dashboard in two ways:

Expand Down Expand Up @@ -88,7 +90,7 @@
If code within a page becomes reusable across other parts of the app,
consider moving it to `src/utils`, `hooks`, `components`, or `modules`.

### Handling States

Check warning on line 93 in docs/about/contributing/frontend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Handling'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

A page typically has three states: **loading**, **ready**/**success**, and
**error**. Ensure you manage these states when developing pages. Use visual
Expand Down Expand Up @@ -253,7 +255,7 @@
We use [Formik](https://formik.org/docs) for forms along with
[Yup](https://github.com/jquense/yup) for schema definition and validation.

## Testing

Check warning on line 258 in docs/about/contributing/frontend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Testing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

We use three types of testing in our app: **End-to-end (E2E)**, **Integration/Unit**
and **Visual Testing**.
Expand Down Expand Up @@ -311,7 +313,7 @@
time-consuming. Sometimes it is because the test itself is complex and sometimes
it is because of how the test is querying elements.

#### Using `ByRole` queries

Check warning on line 316 in docs/about/contributing/frontend.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Using'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

One thing we figured out that was slowing down our tests was the use of `ByRole`
queries because of how it calculates the role attribute for every element on the
Expand Down
4 changes: 3 additions & 1 deletion docs/about/screenshots.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Screenshots
---
title: Screenshots
---

## Log in

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/external-auth/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# External Authentication
---
title: External Authentication
---

Coder supports external authentication via OAuth2.0. This allows enabling any OAuth provider as well as integrations with Git providers,
such as GitHub, GitLab, and Bitbucket.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Administration
---
title: Administration
---

![Admin settings general page](../images/admin/admin-settings-general.png)

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/infrastructure/architecture.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Architecture
---
title: Architecture
---

The Coder deployment model is flexible and offers various components that
platform administrators can deploy and scale depending on their use case. This
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/infrastructure/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Infrastructure
---
title: Infrastructure
---

Learn how to spin up & manage Coder infrastructure.

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/infrastructure/scale-testing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Scale Testing
---
title: Scale Testing
---

Scaling Coder involves planning and testing to ensure it can handle more load
without compromising service. This process encompasses infrastructure setup,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Add an Envbuilder template
---
title: Add an Envbuilder template
---

A Coder administrator adds an Envbuilder-compatible template to Coder. This
allows the template to prompt the developer for their dev container repository's
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/devcontainers/envbuilder/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Envbuilder
---
title: Envbuilder
---

Envbuilder is an open-source tool that builds development environments from
[dev container](https://containers.dev/implementors/spec/) configuration files.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/devcontainers/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Dev Containers
---
title: Dev Containers
---

Dev containers allow developers to define their development environment
as code using the [Dev Container specification](https://containers.dev/).
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Integrations
---
title: Integrations
---

Coder is highly extensible and is not limited to the platforms outlined in these
docs. The control plane can be provisioned on any VM or container compute, and
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/platformx.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# DX PlatformX
---
title: DX PlatformX
---

[DX](https://getdx.com) is a developer intelligence platform used by engineering
leaders and platform engineers. Coder notifications can be transformed to
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/licensing/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Licensing
---
title: Licensing
---

Some features are only accessible with a Premium license, including
[AI Governance](../../ai-coder/ai-governance.md). See our
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/logs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Logs
---
title: Logs
---

All Coder services log to standard output, which can be critical for identifying
errors and monitoring Coder's deployment health. Like any service, logs can be
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/notifications/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Notifications
---
title: Notifications
---

Notifications are sent by Coder in response to specific internal events, such as
a workspace being deleted or a user being created.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/notifications/slack.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Slack Notifications
---
title: Slack Notifications
---

[Slack](https://slack.com/) is a popular messaging platform designed for teams
and businesses, enabling real-time collaboration through channels, direct
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/notifications/teams.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Microsoft Teams Notifications
---
title: Microsoft Teams Notifications
---

[Microsoft Teams](https://www.microsoft.com/en-us/microsoft-teams) is a widely
used collaboration platform, and with Coder's integration, you can enable
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/high-availability.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# High Availability
---
title: High Availability
---

High Availability (HA) mode solves for horizontal scalability and automatic
failover within a single region. When in HA mode, Coder continues using a single
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Networking
---
title: Networking
---

Coder's network topology has three types of nodes: workspaces, coder servers,
and users.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/port-forwarding.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Port Forwarding
---
title: Port Forwarding
---

Port forwarding lets developers securely access processes on their Coder
workspace from a local machine. A common use case is testing web applications in
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/stun.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# STUN and NAT
---
title: STUN and NAT
---

[Session Traversal Utilities for NAT (STUN)](https://www.rfc-editor.org/rfc/rfc8489.html)
is a protocol used to assist applications in establishing peer-to-peer
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Troubleshooting
---
title: Troubleshooting
---

`coder ping <workspace>` will ping the workspace agent and print diagnostics on
the state of the connection. These diagnostics are created by inspecting both
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/security/database-encryption.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Database Encryption
---
title: Database Encryption
---

By default, Coder stores external user tokens and other sensitive values in
plaintext in the database. Database Encryption allows Coder administrators to
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/security/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Security
---
title: Security
---

<children></children>

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/security/secrets.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Secrets
---
title: Secrets
---

Coder is open-minded about how you get your secrets into your workspaces. For
more information about how to use secrets and other security tips, visit our
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/setup/data-retention.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Data Retention
---
title: Data Retention
---

Coder supports configurable retention policies that automatically purge old
Audit Logs, Connection Logs, Workspace Agent Logs, API keys, and AI Gateway
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/setup/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Telemetry
---
title: Telemetry
---

> [!NOTE]
> TL;DR: disable telemetry by setting <code>CODER_TELEMETRY_ENABLE=false</code>.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/creating-templates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Creating Templates
---
title: Creating Templates
---

Users with the `Template Administrator` role or above can create templates
within Coder.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/devcontainers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Dev Containers
---
title: Dev Containers
---

Dev containers extend your template with containerized development environments,
allowing developers to work in consistent, reproducible setups defined by
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Docker in Workspaces
---
title: Docker in Workspaces
---

There are a few ways to run Docker within container-based Coder workspaces.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Dynamic Parameters
---
title: Dynamic Parameters
---

Coder v2.24.0 introduces Dynamic Parameters to extend Coder [parameters](./parameters.md) with conditional form controls,
enriched input types, and user identity awareness.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/icons.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Icons
---
title: Icons
---

Coder uses icons in several places, including ones that can be configured
throughout the app, or specified in your Terraform. They're specified by a URL,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Prebuilt workspaces
---
title: Prebuilt workspaces
---

Prebuilt workspaces (prebuilds) reduce workspace creation time with an automatically-maintained pool of
ready-to-use workspaces for specific parameter presets.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/process-priority.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Improving Agent Resiliency
---
title: Improving Agent Resiliency
---

Coder's agent can automatically lower the scheduling priority
and raise the OOM (out-of-memory) kill score of user processes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Provider Authentication
---
title: Provider Authentication
---

> [!CAUTION]
> Do not store secrets in templates. Assume every user has cleartext access to every template.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Resource Metadata
---
title: Resource Metadata
---

Expose key workspace information to your users with
[`coder_metadata`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/metadata)
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/workspace-tags.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Tags
---
title: Workspace Tags
---

Template administrators can leverage static template tags to limit workspace
provisioning to designated provisioner groups that have locally deployed
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/dependencies.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Template Dependencies
---
title: Template Dependencies
---

When creating Coder templates, it is unlikely that you will just be using
built-in providers. Part of Terraform's flexibility stems from its rich plugin
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/envbuilder.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Envbuilder
---
title: Envbuilder
---

Envbuilder shifts environment definition from template administrators to
developers. Instead of baking tools into template images, developers define
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# External Workspaces
---
title: External Workspaces
---

External workspaces allow you to seamlessly connect externally managed infrastructure as Coder workspaces. This enables you to integrate existing servers, on-premises systems, or any capable machine with the Coder environment, ensuring a smooth and efficient development workflow without requiring Coder to provision additional compute resources.

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/image-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Image Management
---
title: Image Management
---

While Coder provides example
[container images](https://github.com/coder/images) for
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/schedule.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Scheduling
---
title: Workspace Scheduling
---

You can configure a template to control how workspaces are started and stopped.
You can also manage the lifecycle of failed or inactive workspaces.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/open-in-coder.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Open in Coder
---
title: Open in Coder
---

You can embed an "Open in Coder" button into your git repos or internal wikis to
let developers quickly launch a new workspace.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/users/headless-auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Headless Authentication
---
title: Headless Authentication
---

> [!NOTE]
> Creating service accounts requires a [Premium license](https://coder.com/pricing).
Expand Down
Loading
Loading