Metadata#
Volatile policy/reference pages should state:
Owner:
External/system facts verified:
Review by:
Primary sources:
Use a three-month review window for Euler, AI tools, data/security rules, and account capabilities. Use six months for stable lab procedures unless a known change requires earlier review.
Primary-Source Order#
- Current ETH policy or ETH HPC documentation.
- Live read-only system inspection for lab-specific facts.
- Official vendor/project documentation.
- Lab-owner decision for local policy.
Community tutorials may help explain a concept but must not establish current ETH policy, quotas, entitlements, or security behavior.
What Verification Means#
Do not change a date merely because a link still opens. Check the specific claim, command, expected result, affected operating system, and relevant lab policy. Record uncertainty rather than turning an assumption into a rule.
A review record should name the claim, operating system/shell, primary source, read-only observation or synthetic test, date and remaining uncertainty. Record lesson/checker drift separately: a current vendor URL cannot prove a lesson teaches the intended skill. Do not advance all page dates after checking one link.
High-Risk Volatile Claims#
- Euler accounts, limits, partitions, GPU identifiers, storage, and tunnel behavior.
es_fugeentitlement and student caps.- AI tool assessments and allowed data classifications.
- Package, Python, CUDA, PyTorch, editor, and extension versions.
- GitHub authentication and API/security behavior.
- Software available on shared Blade/lab machines.
Review Trigger#
The documentation checker validates that named volatile pages contain review
metadata. Both private source-CI suites fail when a review date has expired.
Run python3 scripts/check_freshness.py locally during the monthly maintenance
review as well, so an overdue page is found even when no source PR is open. The
maintainer verifies the facts rather than automatically advancing the date.