Contributing¶
This repository follows the OzarLand community contribution guide:
CONTRIBUTING.md in ozarland.
In short:
- Give context: OpenStack release, components, deployment method, environment conditions, what you checked.
- No sensitive data: no secrets, real hostnames, domains, IP or MAC addresses, customer or person names, unredacted logs (how to redact).
- Flag risky commands: ⚠️ state-changing, 🛑 destructive (risk warnings).
- Say where it was observed; never present a procedure as universal.
- Use the templates in
templates/, open a pull request, sign off your commits (git commit -s).
Repository-specific notes:
- Put the page in the directory of its primary symptom (
lifecycle/,scheduling/,migration/,networking/,volumes/,recovery/); cross-cutting investigation guides go indiagnostics/, guides to reading a service's logs inlogs/. - Name the file after the symptom, lowercase, hyphenated:
instance-stuck-in-build-waiting-for-vif-plugged.md. - Add the page to the index table in
README.mdin the same pull request. The status badges and progress bars are generated: after adding a page or changing astatus:, runtools/status_blocks.py --writefrom the ozarland repository (usage at the top of the script) and commit what it changes inREADME.md.