Skip to content

Conversation

joshrotenberg
Copy link
Contributor

Summary

This PR transforms the repository into a comprehensive documentation site using MkDocs with Material theme, while preserving the existing repository structure for backward compatibility.

Preview Locally

To preview the documentation site locally:

# Install MkDocs Material
pip install mkdocs-material

# Serve the documentation site
mkdocs serve

# Access at: http://127.0.0.1:8000/redis-enterprise-observability/

The site will auto-reload when you make changes to the documentation files.

Features Added

  • Complete documentation site with Material theme, search, and navigation
  • Platform documentation for all integrations (Grafana, Prometheus, Dynatrace, New Relic, Splunk, Kibana)
  • Dashboard catalog with organized tables and direct download links
  • Comprehensive guides for alerting, troubleshooting, performance tuning, and Redis Cloud monitoring
  • Reference documentation for metrics, API endpoints, and compatibility matrix
  • Automatic documentation generation from existing READMEs to maintain single source of truth
  • GitHub Actions workflow for automatic deployment to GitHub Pages

Structure

docs/
├── index.md                    # Main landing page
├── getting-started/            # Getting started guides
├── platforms/                  # Platform-specific docs
│   ├── grafana/               # Grafana integration
│   ├── prometheus/            # Prometheus and alerting
│   └── ...                    # Other platforms
├── dashboards/                 # Dashboard catalog
├── guides/                     # Task-oriented guides
└── reference/                  # Reference documentation

mkdocs.yml                      # MkDocs configuration
generate-docs.sh               # Script to regenerate docs from READMEs

Key Benefits

  1. Searchable navigation - Easy to find specific information
  2. Organized structure - Logical grouping of related content
  3. Backward compatibility - Existing repo structure preserved
  4. Auto-deployment - GitHub Pages deployment via Actions
  5. Single source of truth - Generated from existing READMEs
  6. Professional appearance - Material Design theme with dark/light mode

Deployment

Once merged, the documentation will be automatically deployed to:
https://redis-field-engineering.github.io/redis-enterprise-observability/

Testing

  • ✅ MkDocs site builds without errors
  • ✅ All navigation links work
  • ✅ Content displays correctly
  • ✅ Site serves locally and is responsive

Future Enhancements

  • Version selector for different Redis Enterprise versions
  • Interactive dashboard previews
  • Video tutorials integration

This creates a professional documentation experience while maintaining all existing functionality.

- Add MkDocs configuration with Material theme
- Create platform documentation for all integrations
- Build complete dashboard catalog with organized tables
- Add comprehensive guides for alerting, troubleshooting, performance tuning
- Include reference documentation for metrics, API, and compatibility
- Preserve existing repository structure for backward compatibility
- Generate documentation from existing READMEs to maintain single source of truth
- Remove references to missing documentation files
- Add Performance Tuning guide to navigation
- Remove awesome-pages plugin dependency
- Fix index.md links to point to existing files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant