Add Antora-based documentation site

[joshrotenberg]

Overview

This PR introduces an Antora-based documentation site as an alternative to the MkDocs implementation in #65.

What's Changed

Documentation Structure

• ✅ Installed Antora as a dev dependency
• ✅ Created comprehensive documentation structure using AsciiDoc
• ✅ Added platform-specific integration guides:
  • Grafana
  • Prometheus
  • Dynatrace
  • New Relic
  • Splunk
  • Kibana
• ✅ Included operational guides:
  • Monitoring Redis Cloud
  • Alerting configuration
  • Troubleshooting
• ✅ Added reference documentation:
  • Complete metrics reference
  • Configuration options
• ✅ Configured build scripts (npm run docs)
• ✅ Updated .gitignore to exclude build artifacts

Latest Updates

• ✅ Added "Example Configurations" sections to all platform pages
  • Direct GitHub links to production-ready alert rules
  • Links to complete dashboard JSON files
  • Working docker-compose demo environments
  • OpenTelemetry Collector configurations
  • Terraform deployment modules
• ✅ Created tracking issue Documentation Enhancement: Testing, Templates, and Configuration Guidance #75 for additional documentation enhancements
  • Testing & validation guide
  • Quick start templates
  • Production deployment checklist

Why Antora?

The team expressed preference for Antora over MkDocs. Antora offers:

• Component-based documentation architecture
• Support for multiple versions
• AsciiDoc format (more powerful than Markdown)
• Modular documentation structure
• Better suited for enterprise documentation

How to Build

# Install dependencies
npm install

# Generate the site
npm run docs

# View the site
open build/site/index.html

# Or serve locally
npm run docs:serve
# Visit http://localhost:8080

Documentation Structure

docs/
├── antora.yml              # Component descriptor
└── modules/
    └── ROOT/
        ├── nav.adoc       # Navigation
        └── pages/         # Content
            ├── index.adoc
            ├── platforms/
            ├── dashboards/
            ├── guides/
            └── reference/

Key Features

• Production-ready examples: Each platform page now links directly to tested configurations in the repository
• Complete coverage: Documentation covers concepts with practical, copy-paste ready examples
• Clear next steps: Users can immediately find working configurations without searching the repo
• Future improvements tracked: Issue Documentation Enhancement: Testing, Templates, and Configuration Guidance #75 tracks testing guides, templates, and production checklists

Next Steps

• Review documentation content
• Configure GitHub Pages deployment
• Add versioning strategy
• Consider implementing enhancements from Documentation Enhancement: Testing, Templates, and Configuration Guidance #75

Related

• Provides alternative to feat: add comprehensive documentation site with MkDocs #65
• Creates issue Documentation Enhancement: Testing, Templates, and Configuration Guidance #75 for future documentation improvements