Add Antora-based documentation site

.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Antora Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'antora-playbook.yml'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build Antora site
+        run: npm run docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./build/site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -12,9 +12,16 @@ logs
 # Lock files
 *.lock
 
+# Node modules
+node_modules/
+
 playbook/target
 
 .vscode
+
+# Antora build output
+build/
+
 .tfvars
 
 # Local .terraform directories
@@ -29,8 +36,8 @@ crash.log
 crash.*.log
 
 # Exclude all .tfvars files, which are likely to contain sensitive data, such as
-# password, private keys, and other secrets. These should not be part of version 
-# control as they are data points which are potentially sensitive and subject 
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
 # to change depending on the environment.
 *.tfvars
 *.tfvars.json
@@ -44,4 +51,4 @@ override.tf.json
 
 # Ignore transient lock info files created by terraform apply
 .terraform.tfstate.lock.info
-.claude
+.claude

README.md

@@ -0,0 +1,91 @@
+# Redis Enterprise Observability
+
+Comprehensive monitoring and observability solutions for Redis Enterprise deployments.
+
+## Overview
+
+This repository provides pre-built dashboards, metrics configurations, and integration guides for monitoring Redis Enterprise across multiple observability platforms.
+
+## Supported Platforms
+
+- **Grafana** - Visualization and analytics
+- **Prometheus** - Metrics collection and time-series storage
+- **Dynatrace** - Full-stack monitoring
+- **New Relic** - Application performance monitoring
+- **Splunk** - Log analytics and SIEM
+- **Kibana** - Elasticsearch visualization
+
+## Documentation
+
+📚 **[View the complete documentation](https://redis-field-engineering.github.io/redis-enterprise-observability/)**
+
+The documentation includes:
+- Quick start guides
+- Platform-specific integration instructions
+- Dashboard catalog
+- Monitoring best practices
+- Alerting configuration
+- Metrics reference
+- Troubleshooting guides
+
+### Building Documentation Locally
+
+```bash
+# Install dependencies
+npm install
+
+# Generate documentation site
+npm run docs
+
+# View the site
+open build/site/index.html
+
+# Or serve locally
+npm run docs:serve
+# Visit http://localhost:8080
+```
+
+## Quick Start
+
+1. Choose your observability platform
+2. Follow the platform-specific guide in the [documentation](https://redis-field-engineering.github.io/redis-enterprise-observability/)
+3. Import pre-built dashboards from the catalog
+4. Configure alerting based on your requirements
+
+## Repository Structure
+
+```
+.
+├── docs/                      # Antora documentation source
+│   ├── antora.yml            # Component descriptor
+│   └── modules/ROOT/
+│       ├── pages/            # Documentation pages (AsciiDoc)
+│       └── nav.adoc          # Navigation menu
+├── grafana/                   # Grafana dashboards
+├── prometheus/                # Prometheus configurations
+├── dynatrace/                 # Dynatrace integrations
+├── newrelic/                  # New Relic dashboards
+├── splunk/                    # Splunk configurations
+└── kibana/                    # Kibana dashboards
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+For documentation contributions, see [docs/README.md](docs/README.md).
+
+## Resources
+
+- [Redis Enterprise Documentation](https://docs.redis.com/latest/rs/)
+- [Redis Cloud Documentation](https://docs.redis.com/latest/rc/)
+- [Antora Documentation](https://docs.antora.org/)
+
+## License
+
+See [LICENSE](LICENSE) for details.

antora-playbook.yml

@@ -0,0 +1,24 @@
+site:
+  title: Redis Enterprise Observability
+  start_page: redis-enterprise-observability::index.adoc
+  url: https://redis-field-engineering.github.io/redis-enterprise-observability
+
+content:
+  sources:
+    - url: .
+      branches: HEAD
+      start_path: docs
+
+ui:
+  bundle:
+    url: https://github.com/redis/antora-ui-redis/releases/latest/download/ui-bundle.zip
+    snapshot: true
+  supplemental_files:
+    - path: ui.yml
+      contents: |
+        static_files:
+        - .nojekyll
+    - path: .nojekyll
+
+output:
+  dir: ./build/site

docs/README.md

@@ -0,0 +1,65 @@
+# Redis Enterprise Observability Documentation
+
+This directory contains the Antora-based documentation for Redis Enterprise Observability.
+
+## Building the Documentation
+
+### Prerequisites
+
+- Node.js (LTS version recommended)
+- npm
+
+### Build Commands
+
+```bash
+# Install dependencies (if not already installed)
+npm install
+
+# Generate documentation site
+npm run docs
+
+# Serve the site locally (requires http-server)
+npm run docs:serve
+```
+
+The generated site will be available at `build/site/index.html` or http://localhost:8080 when using the serve command.
+
+## Documentation Structure
+
+The documentation follows Antora's standard structure:
+
+```
+docs/
+├── antora.yml                 # Component descriptor
+└── modules/
+    └── ROOT/
+        ├── nav.adoc          # Navigation menu
+        ├── pages/            # Documentation pages (AsciiDoc)
+        │   ├── index.adoc
+        │   ├── platforms/
+        │   ├── dashboards/
+        │   ├── guides/
+        │   └── reference/
+        ├── images/           # Images and screenshots
+        ├── examples/         # Code examples
+        └── attachments/      # Downloadable files
+```
+
+## Writing Documentation
+
+- Documentation is written in AsciiDoc format (`.adoc` files)
+- Place new pages in the appropriate `pages/` subdirectory
+- Update `nav.adoc` to add pages to the navigation menu
+- Use cross-references with `xref:` to link between pages
+
+## Contributing
+
+1. Add or modify `.adoc` files in `docs/modules/ROOT/pages/`
+2. Update navigation in `docs/modules/ROOT/nav.adoc` if adding new pages
+3. Build and test locally with `npm run docs`
+4. Submit a pull request with your changes
+
+## Resources
+
+- [Antora Documentation](https://docs.antora.org/)
+- [AsciiDoc Syntax](https://docs.asciidoctor.org/asciidoc/latest/)

docs/antora.yml

@@ -0,0 +1,5 @@
+name: redis-enterprise-observability
+version: latest
+title: Redis Enterprise Observability
+nav:
+- modules/ROOT/nav.adoc

docs/modules/ROOT/nav.adoc

@@ -0,0 +1,22 @@
+* xref:index.adoc[Overview]
+* xref:quick-start.adoc[Quick Start]
+
+.Platforms
+* xref:platforms/grafana.adoc[Grafana]
+* xref:platforms/prometheus.adoc[Prometheus]
+* xref:platforms/dynatrace.adoc[Dynatrace]
+* xref:platforms/newrelic.adoc[New Relic]
+* xref:platforms/splunk.adoc[Splunk]
+* xref:platforms/kibana.adoc[Kibana]
+
+.Dashboards
+* xref:dashboards/catalog.adoc[Dashboard Catalog]
+
+.Guides
+* xref:guides/monitoring-redis-cloud.adoc[Monitoring Redis Cloud]
+* xref:guides/alerting.adoc[Alerting]
+* xref:guides/troubleshooting.adoc[Troubleshooting]
+
+.Reference
+* xref:reference/metrics.adoc[Metrics Reference]
+* xref:reference/configuration.adoc[Configuration]