Files
coder/docs/reference/cli/provisioner/start.md
T
Nick Vigilante 6e51c66a97 docs: give every table header cell text and fail lint on empty ones (#30879)
## Summary

axe reports `empty-table-header` on 116 generated CLI reference pages
and several hand-written pages: a header cell with no text is announced
by screen readers as an unnamed column. This PR gives every table header
cell in `docs/` text, and adds a lint check so empty header cells can't
come back.

## How to review this PR

- `docs/reference/cli/`: 116 files, these all generate identically, so I
would only spot check 2-3 of them and skip the rest
- `docs/*` outside of `docs/reference/cli/`: 6 files, normal review of
these
- `scripts`: 5 files, code review of the Bash and Go files to make sure
we're properly inserting headers into each table

## What changed

**Generator.** `scripts/clidocgen` wrote an empty header row (`| | |`)
over each option's metadata table (Type, Environment, YAML, Default). It
now writes `| Property | Value |`. Subcommand tables already had `Name |
Purpose` and are unchanged. Regenerated with `make
docs/reference/cli/index.md`: 116 files under `docs/reference/cli/`
change. The header rows change, and the body rows of each option table
are re-padded to the wider first column; the content is otherwise
identical. Every option on those 116 pages now shows a visible `Property
| Value` header row above Type, Environment, YAML, and Default, so this
is a visual change on the docs site as well as a screen reader one. The
CLI's own `--help` output doesn't use this template, so it's unchanged.

**Audit logs.** `docs/admin/security/audit-logs.md` already has `Field |
Tracked` headers on `main` (the generator writes them), so there was
nothing to change there; the live-site finding predates that.

**Hand-written tables.**
- `docs/admin/networking/port-forwarding.md`: the CORS matrix had three
empty spanning corner cells. The corner now reads `From user` and `From
workspace` (spanning the three row-header columns, beside the Alice/Bob
and Workspace rows) and `To user`, `To workspace`, `To app` (over the
three row-header columns). The grid is still 3 header rows by 7 columns.
The From cells have `scope="row"` and the other header-row cells
`scope="col"`, so the From labels don't become column headers for the
body's label columns; the body's user, workspace, and app labels are
`<th scope="row">`; and a `<caption>` says columns are the origin and
rows the destination.
- `groups-roles.md`, `airgap.md`, `scale-testing.md`,
`workspace-tags.md`: these four corner cells are already filled by
#30873. The new check would fail CI without them, so this PR carries the
same four lines, byte-identical to #30873 (`Permission`, `Component`,
`Scenario`, `Input`), so whichever PR merges second rebases without
conflict. If #30873 merges first, these hunks drop out.

**New check.** `scripts/docshtmlcheck` (`make lint/docs-html`, part of
`make lint`) now also reports `empty-table-header`. I put it there
because that checker already parses every Markdown file under `docs/`,
generated pages included, with goldmark and tokenizes raw HTML with
`golang.org/x/net/html`, and it already runs in CI. A markdownlint
custom rule would have needed a new JS rule and HTML parsing there.
- Markdown pipe tables: the header row, via goldmark's GFM table
extension.
- Raw HTML tables: every `<th>`, tracked across HTML blocks, with
entities decoded and whitespace trimmed, so `<th></th>`,
`<th>&nbsp;</th>`, and `<th><br></th>` are all reported. Markdown
between the HTML blocks of an open `<th>` counts as its text. Tables in
code blocks are ignored.
- Output: `docs/x.md:29: empty-table-header: header cell 1 has no text
(table's first header "Auditor")`, plus a summary footer.
- The tokenizer loop moved out of `scanNode` into a shared
`tokenizeSegments` helper so both checks use it; `scanNode`'s behavior
is unchanged.
- The style guide's checks table gets one row; the README for the
checker describes the rule.

## Testing

- Tests first: `TestCheckTables` (now 22 cases) and
`TestRunEmptyTableHeader` failed against a stub, then pass. The existing
`docshtmlcheck` tests pass unchanged.
- `go run ./scripts/docshtmlcheck` on `main` reports 1,561 empty header
cells (116 CLI pages, port-forwarding, and the four #30873 tables); on
this branch it reports none.
- `go test ./scripts/docshtmlcheck/ ./scripts/clidocgen/
./scripts/docgenenv/`, golangci-lint on the changed packages, `make
lint/docs-html lint/docs-manifest lint/docs-gen-filter lint/emdash`,
`pnpm run check-docs`, and Vale on the changed hand-written pages all
pass.
- `make gen` couldn't run to completion locally (no `protoc-gen-go`);
CI's gen check covers it. The CLI pages were regenerated with the repo's
own target.

Review feedback applied in cfd29a2160 (entities decoded in Markdown
text, image alt text and autolinks count as text), 709a58f603 (per-kind
counts, finding order, CLI generator note), 8e61ff3afa (CORS matrix
scopes and caption), and b807bcbbc7 and 2871f89bdf (style guide rule
section, `make lint/docs-html` in the checks table, coverage counts).

Linear: DOCS-1308

---

🤖 Built with AI assistance.
2026-10-21 10:58:04 -07:00

5.7 KiB
Generated

title, description
title description
`coder provisioner start` Run a provisioner daemon.

Run a provisioner daemon

Usage

coder provisioner start [flags]

Options

-c, --cache-dir

Property Value
Type string
Environment $CODER_CACHE_DIRECTORY
Default ~/.cache/coder

Directory to store cached data.

-t, --tag

Property Value
Type string-array
Environment $CODER_PROVISIONERD_TAGS

Tags to filter provisioner jobs by.

--poll-interval

Property Value
Type duration
Environment $CODER_PROVISIONERD_POLL_INTERVAL
Default 1s

Deprecated and ignored.

--poll-jitter

Property Value
Type duration
Environment $CODER_PROVISIONERD_POLL_JITTER
Default 100ms

Deprecated and ignored.

--psk

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_PSK

Pre-shared key to authenticate with Coder server.

--key

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_KEY

Provisioner key to authenticate with Coder server.

--name

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_NAME

Name of this provisioner daemon. Defaults to the current hostname without FQDN.

--verbose

Property Value
Type bool
Environment $CODER_PROVISIONER_DAEMON_VERBOSE
Default false

Output debug-level logs.

--log-human

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_LOGGING_HUMAN
Default /dev/stderr

Output human-readable logs to a given file.

--log-json

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_LOGGING_JSON

Output JSON logs to a given file.

--log-stackdriver

Property Value
Type string
Environment $CODER_PROVISIONER_DAEMON_LOGGING_STACKDRIVER

Output Stackdriver compatible logs to a given file.

--log-filter

Property Value
Type string-array
Environment $CODER_PROVISIONER_DAEMON_LOG_FILTER

Filter debug logs by matching against a given regex. Use .* to match all debug logs.

--prometheus-enable

Property Value
Type bool
Environment $CODER_PROMETHEUS_ENABLE
Default false

Serve prometheus metrics on the address defined by prometheus address.

--prometheus-address

Property Value
Type string
Environment $CODER_PROMETHEUS_ADDRESS
Default 127.0.0.1:2112

The bind address to serve prometheus metrics.

--experiments

Property Value
Type string-array
Environment $CODER_EXPERIMENTS
YAML experiments

Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '*' to opt-in to all available experiments.

-O, --org

Property Value
Type string
Environment $CODER_ORGANIZATION

Select which organization (uuid or name) to use.