firefrost-gaming/firefrost-operations-manual
3
0
Fork 0
Code Issues 146 Pull Requests Packages Projects Releases Wiki Activity
Files
3de6e44a055400b58f1e2575628a9362cad0e08b
firefrost-operations-manual/docs/archive/root-cleanup-2026-03-28/README-INDEX.md
Claude (Chronicler #45) 3de6e44a05 chore: root directory cleanup and .gitignore hardening 
WHAT WAS DONE:
- Moved 33 accumulated root-level .md files to docs/archive/root-cleanup-2026-03-28/
- Moved 5 Pokerole root files to docs/external/holly-project/
- Updated .gitignore to cover *.pem, *.key, .env, .DS_Store etc.
- Added explanatory README to the archive folder
- Root now contains only 7 essential files

WHY:
Full repository audit (first full clone) revealed root had accumulated
40 .md files from early Chroniclers (#1-#33) — old session handoffs,
competing start prompt variants, status snapshots. None deleted, all
preserved in archive. Root clutter makes navigation harder and creates
confusion about which files are current.

ROOT FILES KEPT:
- README.md, CHANGELOG.md, DOCUMENT-INDEX.md
- SESSION-HANDOFF-NEXT.md, SESSION-HANDOFF-PREVIOUS.md
- SESSION-HANDOFF-PROTOCOL.md, SESSION-HANDOFF-TEMPLATE.md

.GITIGNORE ADDITIONS:
- *.pem, *.key, *.p12, *.pfx (intentionally NOT *.ppk yet)
- .env, .env.*, *.secret
- .DS_Store, Thumbs.db

NOTE: SSH key intentionally left per Michael's decision.

FILES MOVED: 38 files reorganized, 0 deleted

Signed-off-by: Chronicler #45 <claude@firefrostgaming.com>
2026-03-28 21:24:13 +00:00

9.8 KiB
Raw Blame History

📚 Firefrost Gaming Operations Manual - Complete Index

Last Updated: 2026-02-17
Version: Starfleet Grade
Status: PRODUCTION READY

🚀 QUICK START

New to the repository? Start here:

  1. docs/planning/mission-statement.md - Understand our philosophy
  2. docs/core/infrastructure-manifest.md - See what we run
  3. docs/quick-reference/common-operations.md - Daily operations
  4. docs/emergency-protocols/ - Emergency procedures

📁 DIRECTORY STRUCTURE

firefrost-operations-manual/
├── deployments/              # Production-ready deployment packages
│   ├── whitelist-manager/    # Flask web app (3 files)
│   ├── staggered-restart/    # Python automation (1 file)
│   └── world-backup/         # Backup automation (3 files)
│
├── docs/
│   ├── core/                 # Critical infrastructure docs (17 files)
│   ├── diagrams/             # Visual network/system diagrams (4 files)
│   ├── emergency-protocols/  # Red/Yellow Alert procedures (2 files)
│   ├── metrics/              # SLAs and performance targets (1 file)
│   ├── planning/             # Strategic documents (14 files)
│   ├── quick-reference/      # One-page operation guides (1 file)
│   ├── reference/            # Technical references (17 files)
│   ├── sessions/             # Session summaries (2 files)
│   ├── tasks/                # 28 task directories
│   └── training/             # Staff training curriculum (1 file)
│
└── README.md                 # Repository overview

🎯 BY USE CASE

I need to...

Deploy a new service:

  1. Check docs/tasks/[service-name]/deployment-plan.md
  2. Review docs/core/infrastructure-manifest.md
  3. Follow step-by-step guide
  4. Update manifest when complete

Handle an emergency:

  1. Assess severity (Red or Yellow Alert)
  2. Follow docs/emergency-protocols/RED-ALERT-*.md or YELLOW-ALERT-*.md
  3. Communicate per protocol
  4. Document in post-mortem

Perform daily operations:

  1. Use docs/quick-reference/common-operations.md
  2. Check docs/metrics/sla-definitions-and-targets.md for targets
  3. Monitor via Uptime Kuma
  4. Log any issues

Train a new staff member:

  1. Follow docs/training/staff-training-curriculum.md
  2. Provide access per docs/tasks/department-structure/README.md
  3. Assign role-specific reading
  4. Track progress

Understand the infrastructure:

  1. Read docs/core/infrastructure-manifest.md
  2. View docs/diagrams/complete-infrastructure-map.mermaid
  3. Review docs/diagrams/frostwall-network-topology.mermaid
  4. Check docs/core/project-scope.md

📋 CORE DOCUMENTS (17 files)

Document Purpose Priority
infrastructure-manifest.md Complete infrastructure inventory CRITICAL
project-scope.md Project vision and roadmap HIGH
tasks.md All tasks and priorities HIGH
workflow-guide.md How to work with Claude HIGH
session-handoff.md Session continuity protocol HIGH
SESSION-START-PROMPT.md Quick session start MEDIUM
DERP.md Emergency recovery procedures CRITICAL
EMERGENCY-GIT-ACCESS.md Git access recovery CRITICAL
GITEA-API-PATTERNS.md API usage patterns MEDIUM
revision-control-standard.md Git commit standards (FFG-STD-001) HIGH
memorial-completion-task.md End-of-session protocol MEDIUM
API-EFFICIENCY-PROTOCOL.md Optimize API usage MEDIUM
Others Various operational docs MEDIUM

🎨 DIAGRAMS (4 files)

Diagram Type View With
frostwall-network-topology.mermaid Network security architecture Mermaid viewer
complete-infrastructure-map.mermaid All services overview Mermaid viewer
task-prioritization-flowchart.mermaid Decision tree for tasks Mermaid viewer
(More in docs/reference/diagrams/) Legacy diagrams Various

How to view Mermaid diagrams:

🚨 EMERGENCY PROTOCOLS (2 files)

Protocol When to Use Response Time
RED-ALERT-complete-failure.md All services down 5 min acknowledge
YELLOW-ALERT-partial-degradation.md Single service down 15 min acknowledge

Escalation ladder:

  • Minor issue → Daily operations
  • Single service → Yellow Alert
  • Multiple services → Red Alert

📊 METRICS & SLAs (1 file)

Document Contents
sla-definitions-and-targets.md Uptime targets, performance metrics, costs, capacity planning

Key SLAs:

  • Overall uptime: 99.5% monthly
  • Game server TPS: 19.5-20.0 target
  • Response times: <100ms latency

🎓 TRAINING (1 file)

Document Purpose
staff-training-curriculum.md 4-level onboarding program

Training Levels:

  1. Orientation (Days 1-3)
  2. Core Skills (Week 1)
  3. Advanced Skills (Week 2-3)
  4. Specialization (Week 4+)

📋 TASKS (28 directories)

Tier 0 - Immediate Wins (3 tasks)

  1. whitelist-manager/ - ✅ READY TO DEPLOY
  2. command-center-cleanup/ - ✅ READY
  3. staff-recruitment-launch/ - ✅ COMPLETE DOCS

Tier 1 - Security Foundation (5 tasks)

  1. vaultwarden-setup/ - ✅ CONFIG GUIDE
  2. frostwall-protocol/ - ✅ COMPLETE (4 files)
  3. command-center-security/ - ✅ DEPLOYMENT GUIDE
  4. scoped-gitea-token/ - ✅ DEPLOYMENT GUIDE

Tier 2 - Major Infrastructure (5 tasks documented)

  1. self-hosted-ai-stack-on-tx1/ - Blocked (medical)
  2. mailcow-email-server-on-nc1/ - Blocked (Frostwall)
  3. netdata-deployment/ - ✅ DEPLOYMENT GUIDE
  4. department-structure/ - ✅ COMPLETE
  5. mkdocs-decommission/ - ✅ DEPLOYMENT GUIDE

Tier 3 - Documentation & Optimization (15 tasks)

  1. fix-frostwall-vs-firefrost-naming/ - ✅ COMPLETE
  2. scope-document-corrections/ - ✅ COMPLETE
  3. workflow-guide-review-&-trim/ - Ready
  4. terraria-branding-training-arc/ - Active Phase 1
  5. paymenter-theme-installation-citadel-theme/ - Ready
  6. consultant-photo-processing/ - Ongoing
  7. nextcloud-upload-portal-for-meg/ - Ready
  8. coming-soon-video-creation-(capcut)/ - Planning
  9. staggered-server-restart-system/ - ✅ COMPLETE
  10. game-server-startup-script-audit-&-optimization/ - ✅ OPTIMIZATION GUIDE
  11. luckperms-mysql-backend/ - Ready
  12. world-backup-automation/ - ✅ COMPLETE
  13. blueprint-extension-installation-node-usage-status/ - Ready
  14. discord-server-complete-reorganization/ - ✅ DEPLOYMENT PLAN
  15. flagship-modpack-eternal-skyforge/ - ✅ DESIGN DOC
  16. among-us-weekly-events-(phase-2-expansion)/ - Planning

🚀 DEPLOYMENT PACKAGES (3 packages)

Package Status Deployment Time
whitelist-manager/ Production-ready 30-45 min
staggered-restart/ Production-ready 2 hours
world-backup/ Production-ready 1-2 hours

All include:

  • Complete code
  • Configuration examples
  • Deployment scripts
  • Documentation

📖 PLANNING DOCUMENTS (14 files)

Strategic and design documents:

  • mission-statement.md - Core philosophy
  • path-philosophy.md - Fire vs Frost
  • subscription-tiers.md - Pricing strategy
  • design-bible.md - Visual/brand guidelines
  • ideas-backlog.md - Future features
  • And 9 more...

📚 REFERENCE DOCUMENTS (17 files)

Technical references:

  • task-directory-audit-2026-02-17.md - Complete audit
  • complete-repository-audit-2026-02-17.md - Full repo audit
  • incident-post-mortem-template.md - Post-incident template
  • terminology-guide.md - Firefrost vocabulary
  • visual-assets-guide.md - Brand assets
  • And 12 more...

🔍 SEARCH SHORTCUTS

By topic:

  • Security: Search for "Frostwall", "security", "hardening"
  • Automation: Search for "restart", "backup", "automation"
  • Emergency: Look in docs/emergency-protocols/
  • Metrics: Check docs/metrics/
  • Training: Start with docs/training/

By file type:

  • Diagrams: .mermaid files in docs/diagrams/
  • Guides: deployment-guide.md or deployment-plan.md
  • Templates: Files ending in -template.md
  • Protocols: Files starting with uppercase (RED-ALERT, etc.)

📈 VERSION HISTORY

v1.0 (Starfleet Grade) - 2026-02-17

  • Added visual diagrams (4 files)
  • Added emergency protocols (2 files)
  • Added metrics & SLAs (1 file)
  • Added training curriculum (1 file)
  • Added quick reference (1 file)
  • Complete repository audit
  • Perfect organization

v0.9 (Enterprise-D) - 2026-02-17

  • 28 task directories documented
  • 3 deployment packages ready
  • Core docs updated
  • Infrastructure manifest v2.0

🎯 NEXT STEPS

For new users:

  1. Read this index
  2. Review mission statement
  3. Check infrastructure manifest
  4. Access training curriculum

For operators:

  1. Bookmark quick reference
  2. Know emergency protocols
  3. Monitor SLAs
  4. Use deployment guides

For developers:

  1. Follow revision control standard
  2. Update documentation with changes
  3. Test deployments thoroughly
  4. Document lessons learned

🤝 CONTRIBUTING

When updating documentation:

  1. Follow FFG-STD-001 (commit standards)
  2. Follow FFG-STD-002 (task documentation)
  3. Update this index if adding new sections
  4. Test procedures before documenting
  5. Use templates where available

🔗 EXTERNAL RESOURCES

  • Gitea: git.firefrostgaming.com
  • Panel: panel.firefrostgaming.com
  • Status: status.firefrostgaming.com
  • Vault: vault.firefrostgaming.com
  • Docs: docs.firefrostgaming.com

Fire + Frost + Foundation = Where Love Builds Legacy 💙🔥❄️

Index Status: CURRENT
Maintained By: The Auditor (Chronicler lineage)
Last Updated: 2026-02-17
Next Review: Monthly

Reference in New Issue View Git Blame Copy Permalink