16 lines
832 B
Markdown
16 lines
832 B
Markdown
|
# Codex prompt: generate repository documentation
|
||
|
|
|
||
|
|
You are working in an Ansible repository that automates a Slurm AI/HPC lab.
|
||
|
|
|
||
|
|
Please review the repository and generate or improve documentation under `docs/` with the following goals:
|
||
|
|
|
||
|
|
1. Explain the architecture and repository layout.
|
||
|
|
2. Document the end-to-end deployment sequence.
|
||
|
|
3. Document operational workflows: provisioning, decommissioning, rolling upgrades, health checks and auto-remediation.
|
||
|
|
4. Document SlurmDBD accounting, QOS, fairshare and priority workflows.
|
||
|
|
5. Add troubleshooting notes based on the playbooks and templates.
|
||
|
|
6. Avoid exposing secrets, real IP addresses, real hostnames, SQL dumps, backup archives, private keys or vault content.
|
||
|
|
7. Keep all text in English.
|
||
|
|
|
||
|
|
Output should be practical, operator-focused and suitable for a public Git repository.
|