restructure documentation
This commit is contained in:
@@ -41,7 +41,7 @@ This is the `tower-of-joy` project - a containerized home server infrastructure
|
||||
**Service Integration Policy:** A service deployment is INCOMPLETE until cross-service integrations are implemented. Every new service MUST be integrated with:
|
||||
- **Uptime Kuma:** Add health check monitor (use `scripts/setup-kuma-monitors.sh` as guide)
|
||||
- **Organizr:** Configure service in dashboard (Settings → Tab Editor, Homepage Items)
|
||||
- **CONTAINERS.md:** Document the service with full profile and configuration table
|
||||
- **docs/reference/CONTAINERS.md:** Document the service with full profile and configuration table
|
||||
|
||||
Services without monitoring and dashboard integration are considered unfinished and should not be marked as "complete" in STATUS.md or commit messages.
|
||||
|
||||
@@ -352,11 +352,11 @@ When deploying a NEW service, follow this complete checklist. A deployment is **
|
||||
- Test external access through proxy
|
||||
|
||||
**Phase 4: Documentation (MANDATORY)**
|
||||
- [ ] Add service profile to `CONTAINERS.md` with:
|
||||
- [ ] Add service profile to `docs/reference/CONTAINERS.md` with:
|
||||
- One-paragraph description
|
||||
- Complete configuration table
|
||||
- All dependencies listed
|
||||
- [ ] Add service to `CONTAINERS.md` quick reference tables:
|
||||
- [ ] Add service to `docs/reference/CONTAINERS.md` quick reference tables:
|
||||
- Service Access Matrix
|
||||
- Storage Distribution (if uses storage)
|
||||
- GPU-Enabled Services (if uses GPU)
|
||||
|
||||
Reference in New Issue
Block a user