Skip to content

Consolidate four deployment guides into a single canonical DEPLOYMENT.md #230

Description

@robertocarlous

Summary

The docs/ directory contains four overlapping deployment documents:

  • DEPLOYMENT.md
  • DEPLOYMENT_GUIDE.md
  • DEPLOYMENT_PRODUCTION.md
  • PRODUCTION_DEPLOYMENT.md

This creates confusion about which guide is authoritative and leads to instructions getting out of sync.

Proposed Solution

  1. Audit all four files for unique content not present in the others
  2. Merge into a single docs/DEPLOYMENT.md with sections:
    • Local development (Docker Compose)
    • Staging (Docker)
    • Production (Kubernetes)
    • Environment variables reference
    • Rollback procedure
  3. Delete the three redundant files
  4. Update docs/DOCUMENTATION_INDEX.md and readme.md to point to the new file

Acceptance Criteria

  • Single docs/DEPLOYMENT.md covers all environments
  • Three redundant files removed
  • No broken links in readme.md or other docs
  • Markdown link check CI step passes

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions