cybertec-postgresql / pg_timetable / 32739079378
89%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 27
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 89.703% (-0.1%) from 89.822%
32739079378

push

github

web-flow 
[!] restructure docs into Diátaxis quadrants (#822)

* WIP

* remove ER diagram

* docs: dedupe BUILTIN parameter schema out of YAML how-to guide

how-to-write-yaml-chains.md re-documented every BUILTIN command's JSON
parameter shape (Sleep, Log, SendMail, Download, Copy*) that already
lives in reference-commands-tasks-chains.md#parameter-value-format,
creating a third source of truth alongside yaml-format.md. Trim the
'Task Parameters' section to two representative YAML examples (SQL,
PROGRAM) and link to the reference for the exhaustive BUILTIN shapes.

Audit finding P0 #3.2 (docs-diataxis-audit.md).

* docs: add 'Your First YAML Chain' tutorial

YAML-authored chains shipped with a how-to and reference but no
onboarding lesson, unlike the original SQL add_job() path. Add a
second tutorial mirroring tutorial-first-chain.md's structure
(sequential, no branching, visible result at every step) using a
BUILTIN Log task on an @reboot schedule so the result is visible
immediately after startup. Wire into mkdocs.yml nav and index.md.

Audit finding P0 #3.1 (docs-diataxis-audit.md).

* docs: expand index.md Learn More to cover all major feature areas

Learn More surfaced 4 links (one per quadrant) out of 18 doc pages,
omitting YAML chains, the secret store, and OpenTelemetry entirely.
Replace the one-per-quadrant listing with one entry per major feature
area (chain scheduling, YAML authoring, secrets, observability), each
linking its how-to/reference pair, plus a pointer to the sidebar nav
for the rest.

Audit finding P1 #3.4 (docs-diataxis-audit.md).

* docs: reword live-flag aside to neutral reference voice

'You can temporarily skip a single step... by toggling the live flag'
was instructional voice inside a Reference document (Diátaxis
anti-pattern 3). Restate as a neutral fact about what the setting
does; keep the SQL as an illustrative example, not an instruction.

Audit finding P2 #3.7 (docs-diataxis-audit.md).

* docs: relocate requirements-doc.txt t... (continued)

2265 of 2525 relevant lines covered (89.7%)

1.02 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
89.15
 -1.16% internal/scheduler/chain.go
Jobs
ID Job ID Ran Files Coverage
1 32739079378.1 27
89.7
 GitHub Action Run
Source Files on build 32739079378