Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.92 KB

index.md

File metadata and controls

35 lines (25 loc) · 1.92 KB

Reference

These pages state what the code does: every option, variable, route and metric, for lookup rather than reading in order. For task-led help, start with configuration.

Find the page for a name

Looking for Page
A link and its options Links
A storage adapter and its options Storage adapters
A tracer and its options JLINC tracer
An API route, its parameters and responses API
A route, its auth and its status code, in one table API routes
An environment variable, its default and where it is read Environment variables
A container, port or Compose profile Ports and services
A metric name, its type and where it is emitted Metrics
A command-line option CLI

Trust the generated pages

scripts/docs/ builds four of these pages from the code, so their names, defaults and types come straight from it: environment variables, ports and services, API routes and metrics. Each generator fails if scripts/docs/descriptions.yml names something the code no longer has.

To change text on one of these pages, edit scripts/docs/descriptions.yml and run scripts/docs/check.sh. Do not edit the page.

Name modules in the YAML file

The module value in the YAML configuration is a Python module path:

Kind Form Example
Link links.<name> links.tag
Storage adapter storage.<name> storage.postgres
Tracer tracers.<name> tracers.jlinc

The folders are conserver/links/, common/storage/ and conserver/tracers/. A link or tracer can also come from an installed package. See dynamic modules.