Pack: analysis-notes

CMS analysis notes, read from a local mirror of gitlab.cern.ch/tdr/notes - notes, sections, figures, bibliography and links to TWiki pages.

Field Value
Kind context
Version 0.1.0
Needs a credential to publish yes
Okg modules it needs document_starter, person, extraction
Packs it needs twiki

In which bundles

Add it to an instance with archi add analysis-notes.

Sources

  • analysis-notes.analysis_notes

Questions

archi init asks these. Answer one with --answer analysis_notes_<id>=VALUE.

Id Type Required Default Prompt
mirror_root string yes directory holding your analysis-note mirror (absolute path)
min_notes integer no 1 fewest note directories the mirror may hold

Credentials

The pack reads these environment variables. Only the names are listed. Put each value in the instance's .env (KEY=value, one per line): archi add and archi ingest pass it to ingestion. A value exported in the shell wins. okg run by hand does not read .env.

  • CERN_GITLAB_TOKEN

Freshness limits

archi doctor compares each source's age with its limit.

Source Longest acceptable age
analysis-notes.analysis_notes 7d

Invariants

The pack owns these checks. They leave with it.

Name Severity What it checks
analysis_notes_coverage error The analysis-note source must have live notes with sections. Required live subtypes: analysis_note, section. A missing one means the mirror was empty, the walker stopped matching its directories, or the connector regressed.

Playbooks

The pack ships no playbook.