C107 — Kanonický a generovaný soubor

Text na stránce tvrzení vypadá jako soubor, který se dá opravit. Většinou to je past.

Dva druhy souborů

Kanonický je zdroj pravdy. V tomhle projektu jsou to JSON záznamy v data/ — tvrzení, zdroje, kauzy, mezery, entity.

Generovaný je výstup. Stránky v content/dossiers/, katalogy, exporty, přehledy. Vznikají z kanonických dat příkazem a při každém buildu se přepíšou.

Jak generovaný soubor poznat

Má v hlavičce generated = true a odkaz na svůj datový model. A hlavně: leží v content/dossiers/, content/entities/, content/zdroje/ nebo content/dokumentace/prikazy/.

Ručně psané jsou naopak koncepty, akademie, bootcamp, příručka a rozcestníky.

Vlastními slovy

Je tenhle soubor generovaný, nebo se edituje ručně?

Když si nejste jistí, tohle je nejrychlejší cesta k odpovědi.

Kde je kanonický vstup

Chcete opravit	Editujte
text tvrzení	`data/dossiers/<slug>/claims/clm-NN.json` a tabulku v `dossier.json`
údaje o zdroji	`data/dossiers/<slug>/sources/src-NN.json`
popis entity	`data/dossiers/_shared/entities/<id>.json`
popis příkazu	`data/tooling/<id>.json`
záznam o registru	`data/source-catalog/<id>.json`

Po editaci se výstup přegeneruje:

Terminál

npm run data:build

Proč to tak je

Kdyby se text tvrzení dal opravit na dvou místech, dřív nebo později by se ta místa rozešla — a čtenář by nevěděl, které je platné. Jeden zdroj pravdy je nuda, ale je to jediné, co drží.

Ověř si, že to sedí

Na stránce zdroje je překlep ve jméně vydavatele. Kde ho opravíte?

Zobrazit odpověď

V kanonickém záznamu zdroje pod data/dossiers/…/sources/, a pak spustíte npm run data:build. Oprava přímo na stránce by zmizela při nejbližším buildu — a nejhorší na tom je, že by to nikdo neohlásil.