Operations and Maintenance
Release model
Documentation uses semantic versioning. Increment major when public concepts or API compatibility break, minor for new supported capabilities and patch for corrections that do not change behavior. Runtime and docs changes should ship together.
Automated checks
- Generate demo tutorials and Bead references from code contracts.
- Validate required frontmatter and accessible image alternatives.
- Lint Markdown and OpenAPI.
- Fail on broken internal links.
- Build the Docusaurus site for the dedicated
https://docs.databraid.eu/origin. - Run template contract and deterministic runtime tests.
Ownership
| Role | Responsibility |
|---|---|
| Documentation Lead | Information architecture, terminology and tutorial quality |
| Runtime Owner | Execution, API and security accuracy |
| Bead Owners | Port, property and provider reference accuracy |
| DevOps | Build, deployment, headers, availability and credential hygiene |
Review cycle
- Every pull request: update affected docs and pass documentation checks.
- Monthly: audit broken links, generated catalog drift and runnable fixtures.
- Quarterly: review architecture, tutorials, search terms and capability status.
- Immediately: update public API behavior, security guidance or deprecated features.
Never publish a README or example containing a real credential. Rotate any exposed credential rather than merely deleting it from the latest revision.