[Docs]: Update documentation for container image upgrades #101

Closed
opened 2026-02-05 23:36:25 +00:00 by egullickson · 1 comment
Owner

Parent Issue

Relates to #95

Summary

Update all documentation to reflect the container image upgrades completed in #95. This should be done last, after all upgrades are verified working.

Files to Modify

1. docs/LOGGING.md

  • Update architecture diagram: "Promtail" references become "Alloy"
  • Update troubleshooting commands: docker logs mvp-promtail -> docker logs mvp-alloy
  • Add note about Alloy replacing Promtail
  • Update any version references if present

2. .ai/context.json

  • Fix container_count from 5 to 9 (outdated from pre-logging era)
  • Update container list if logging stack containers are referenced
  • Update any version metadata

3. CLAUDE.md (root)

  • Update logging container name if referenced: Promtail -> Alloy
  • Line 176 mentions "3 logging (Loki, Promtail, Grafana)" -> "3 logging (Loki, Alloy, Grafana)"

4. README.md (root)

  • Update container architecture description if Promtail is mentioned

Acceptance Criteria

  • docs/LOGGING.md updated with Alloy references
  • .ai/context.json container_count fixed
  • CLAUDE.md updated with Alloy reference
  • All documentation consistent with actual deployed state

Dependencies

  • Blocked by: All upgrade sub-issues completed
  • This is the final sub-issue in the sequence
## Parent Issue Relates to #95 ## Summary Update all documentation to reflect the container image upgrades completed in #95. This should be done last, after all upgrades are verified working. ## Files to Modify ### 1. `docs/LOGGING.md` - Update architecture diagram: "Promtail" references become "Alloy" - Update troubleshooting commands: `docker logs mvp-promtail` -> `docker logs mvp-alloy` - Add note about Alloy replacing Promtail - Update any version references if present ### 2. `.ai/context.json` - Fix `container_count` from 5 to 9 (outdated from pre-logging era) - Update container list if logging stack containers are referenced - Update any version metadata ### 3. `CLAUDE.md` (root) - Update logging container name if referenced: Promtail -> Alloy - Line 176 mentions "3 logging (Loki, Promtail, Grafana)" -> "3 logging (Loki, Alloy, Grafana)" ### 4. `README.md` (root) - Update container architecture description if Promtail is mentioned ## Acceptance Criteria - [ ] docs/LOGGING.md updated with Alloy references - [ ] .ai/context.json container_count fixed - [ ] CLAUDE.md updated with Alloy reference - [ ] All documentation consistent with actual deployed state ## Dependencies - Blocked by: All upgrade sub-issues completed - This is the final sub-issue in the sequence
egullickson added the
status
backlog
type
docs
labels 2026-02-05 23:36:36 +00:00
egullickson added
status
in-progress
and removed
status
backlog
labels 2026-02-06 02:10:17 +00:00
Author
Owner

Milestone: Documentation Update Complete

Phase: Execution | Agent: Platform Agent | Status: PASS

Changes Made

.ai/context.json:

  • Fixed architecture from "simplified-5-container" to "9-container"
  • Fixed container_count from 5 to 9
  • Fixed completeness string from "5-container" to "9-container"
  • Added 4 missing services: mvp-ocr, mvp-loki, mvp-alloy, mvp-grafana

docs/ARCHITECTURE-OVERVIEW.md:

  • Updated architecture description from "5-container" to "9-container (6 application + 3 logging)"
  • Added OCR, Loki, Alloy, Grafana to container list with numbered sections

docs/AUDIT.md:

  • Updated architecture header and executive summary references

docs/DATABASE-SCHEMA.md:

  • Updated architecture reference in description

config/CLAUDE.md:

  • Updated architecture description

Verification

  • Grep sweep confirms zero remaining "5-container" or "Promtail" references in .md/.json files
  • context.json validated as proper JSON
  • docs/PLATFORM-SERVICES.md already had correct "9-container" references
  • CLAUDE.md (root) already had correct "Alloy" references
  • docs/LOGGING.md already had correct "Alloy" references

Acceptance Criteria

  • docs/LOGGING.md updated with Alloy references (already done in prior commits)
  • .ai/context.json container_count fixed (5 -> 9)
  • CLAUDE.md updated with Alloy reference (already done in prior commits)
  • All documentation consistent with actual deployed state

Verdict: PASS | Next: Quality review via PR #102

## Milestone: Documentation Update Complete **Phase**: Execution | **Agent**: Platform Agent | **Status**: PASS ### Changes Made **`.ai/context.json`**: - Fixed `architecture` from `"simplified-5-container"` to `"9-container"` - Fixed `container_count` from `5` to `9` - Fixed `completeness` string from "5-container" to "9-container" - Added 4 missing services: `mvp-ocr`, `mvp-loki`, `mvp-alloy`, `mvp-grafana` **`docs/ARCHITECTURE-OVERVIEW.md`**: - Updated architecture description from "5-container" to "9-container (6 application + 3 logging)" - Added OCR, Loki, Alloy, Grafana to container list with numbered sections **`docs/AUDIT.md`**: - Updated architecture header and executive summary references **`docs/DATABASE-SCHEMA.md`**: - Updated architecture reference in description **`config/CLAUDE.md`**: - Updated architecture description ### Verification - Grep sweep confirms zero remaining "5-container" or "Promtail" references in .md/.json files - `context.json` validated as proper JSON - `docs/PLATFORM-SERVICES.md` already had correct "9-container" references - `CLAUDE.md` (root) already had correct "Alloy" references - `docs/LOGGING.md` already had correct "Alloy" references ### Acceptance Criteria - [x] docs/LOGGING.md updated with Alloy references (already done in prior commits) - [x] .ai/context.json container_count fixed (5 -> 9) - [x] CLAUDE.md updated with Alloy reference (already done in prior commits) - [x] All documentation consistent with actual deployed state *Verdict*: PASS | *Next*: Quality review via PR #102
egullickson added
status
review
and removed
status
in-progress
labels 2026-02-06 02:12:08 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: egullickson/motovaultpro#101