## Summary **Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`). Adds a front-matter `title` to every navigable docs page whose title can be migrated **mechanically**, with no editorial judgment. This is the content step that Phase 1 (renderers prefer front-matter title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware, `DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged and live. **Rendered no-op.** The renderers already resolve the page title from the manifest and hide the leading body H1 (Phase 1), so no page changes visually. This just moves the title into front matter where Fumadocs and the migrated tooling can read it. ## What's in this batch Dry-run on `main` (464 navigable pages) splits into: | category | count | this PR | |----------|-------|---------| | already has front-matter title (Reference, from Phase 2 generators) | 196 | skipped (idempotent) | | **mechanical** — leading body H1 equals the manifest label | 138 | ✅ add front-matter `title`, drop the duplicate H1 | | **no body H1** — renders under the manifest label only | 4 | ✅ add front-matter `title` only | | **mismatch** — body H1 differs from the manifest label | 126 | ⏭️ deferred (needs an editorial decision, see below) | 142 files changed, all under `docs/`. ## Deliberately out of scope: the 126 mismatches Pages where the body H1 is richer than the short sidebar label (e.g. label **Modules** / H1 *Contributing modules*, label **Install** / H1 *Installing Coder*) need a canonical-title decision, not a script. A few even look like the body H1 is the redundant one (`install/cli.md` and `install/index.md` both carry the H1 *Installing Coder*). These will land in follow-up batches **by nav section** once the policy is set, so each gets real review. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Every added front-matter block parses as YAML and its `title` round-trips to the manifest label (checked programmatically across all 142 files). - Every removed line is a leading `# H1` that equalled the manifest title; no body prose was reflowed. Front matter is correctly hoisted above pre-existing `<!-- markdownlint-disable -->` comments on the two pages that had them. - `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in Phase 4); `MD025` is not tripped because the duplicate body H1s are removed. ``` $ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main) Linting: 142 file(s) Summary: 0 error(s) ``` Linear: DOCS-484 > This PR was created with AI assistance (Coder Agents).
113 lines
3.2 KiB
Markdown
113 lines
3.2 KiB
Markdown
---
|
|
title: Reference
|
|
---
|
|
|
|
## Automation
|
|
|
|
All actions possible through the Coder dashboard can also be automated. There
|
|
are several ways to extend/automate Coder:
|
|
|
|
- [coderd Terraform Provider](https://registry.terraform.io/providers/coder/coderd/latest)
|
|
- [CLI](../reference/cli/index.md)
|
|
- [REST API](../reference/api/index.md)
|
|
- [Coder SDK](https://pkg.go.dev/github.com/coder/coder/v2/codersdk)
|
|
- [Agent API](../reference/agent-api/index.md)
|
|
|
|
## Quickstart
|
|
|
|
Generate a token on your Coder deployment by visiting:
|
|
|
|
```sh
|
|
https://coder.example.com/settings/tokens
|
|
```
|
|
|
|
List your workspaces
|
|
|
|
```sh
|
|
# CLI
|
|
coder ls \
|
|
--url https://coder.example.com \
|
|
--token <your-token> \
|
|
--output json
|
|
|
|
# REST API (with curl)
|
|
curl https://coder.example.com/api/v2/workspaces?q=owner:me \
|
|
-H "Coder-Session-Token: <your-token>"
|
|
```
|
|
|
|
## Documentation
|
|
|
|
We publish an [API reference](../reference/api/index.md) in our documentation.
|
|
You can also enable a
|
|
[Swagger endpoint](../reference/cli/server.md#--swagger-enable) on your Coder
|
|
deployment.
|
|
|
|
## Use cases
|
|
|
|
We strive to keep the following use cases up to date, but please note that
|
|
changes to API queries and routes can occur. For the most recent queries and
|
|
payloads, we recommend checking the relevant documentation.
|
|
|
|
### Users & Groups
|
|
|
|
- [Manage Users via Terraform](https://registry.terraform.io/providers/coder/coderd/latest/docs/resources/user)
|
|
- [Manage Groups via Terraform](https://registry.terraform.io/providers/coder/coderd/latest/docs/resources/group)
|
|
|
|
### Templates
|
|
|
|
- [Manage templates via Terraform or CLI](../admin/templates/managing-templates/change-management.md):
|
|
Store all templates in git and update them in CI/CD pipelines.
|
|
|
|
### Workspace agents
|
|
|
|
Workspace agents have a special token that can send logs, metrics, and workspace
|
|
activity.
|
|
|
|
- [Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs):
|
|
Expose messages prior to the Coder init script running (e.g. pulling image, VM
|
|
starting, restoring snapshot).
|
|
[coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
|
|
this to show Kubernetes events, such as image pulls or ResourceQuota
|
|
restrictions.
|
|
|
|
```sh
|
|
curl -X PATCH https://coder.example.com/api/v2/workspaceagents/me/logs \
|
|
-H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
|
|
-d "{
|
|
\"logs\": [
|
|
{
|
|
\"created_at\": \"$(date -u +'%Y-%m-%dT%H:%M:%SZ')\",
|
|
\"level\": \"info\",
|
|
\"output\": \"Restoring workspace from snapshot: 05%...\"
|
|
}
|
|
]
|
|
}"
|
|
```
|
|
|
|
- [Manually send workspace activity](../reference/api/workspaces.md#extend-workspace-deadline-by-id):
|
|
Keep a workspace "active," even if there is not an open connection (e.g. for a
|
|
long-running machine learning job).
|
|
|
|
```sh
|
|
#!/bin/bash
|
|
# Send workspace activity as long as the job is still running
|
|
|
|
while true
|
|
do
|
|
if pgrep -f "my_training_script.py" > /dev/null
|
|
then
|
|
curl -X PUT "https://coder.example.com/api/v2/workspaces/$WORKSPACE_ID/extend" \
|
|
-H "Coder-Session-Token: $CODER_AGENT_TOKEN" \
|
|
-d '{
|
|
"deadline": "2019-08-24T14:15:22Z"
|
|
}'
|
|
|
|
# Sleep for 30 minutes (1800 seconds) if the job is running
|
|
sleep 1800
|
|
else
|
|
# Sleep for 1 minute (60 seconds) if the job is not running
|
|
sleep 60
|
|
fi
|
|
done
|
|
```
|