-
Notifications
You must be signed in to change notification settings - Fork 2
Add Antora-based documentation site #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add Antora-based documentation site #74
Conversation
- Install Antora as dev dependency - Create comprehensive documentation structure with AsciiDoc - Add platform guides for Grafana, Prometheus, Dynatrace, New Relic, Splunk, Kibana - Include guides for monitoring, alerting, and troubleshooting - Add metrics and configuration reference documentation - Configure build scripts for generating and serving docs - Update .gitignore to exclude build output
- Automatically builds and deploys docs on push to main - Triggers on changes to docs/, antora-playbook.yml, or workflow file - Supports manual workflow dispatch - Uses GitHub Pages for deployment
- Use github.com/redis/antora-ui-redis UI bundle - Ensures consistent look and feel across Redis Field Engineering projects - Adds .nojekyll file for GitHub Pages compatibility - Aligns with redis-kafka-connect and other FE project styling
Added detailed, production-ready examples for: Prometheus: - Multi-cluster monitoring configurations - TLS/SSL setup - Kubernetes and Consul service discovery - Recording rules for performance - Retention and storage configuration - Troubleshooting commands and fixes Grafana: - Data source provisioning (UI, file, docker-compose) - Dashboard import methods (UI, API, provisioning) - Template variable configuration - Panel examples (timeseries, gauge, stat) - Alert rule configuration - Notification channels setup Alerting: - Complete Prometheus alert rules (critical and warning) - Full Alertmanager configuration with routing - PagerDuty and Slack integration examples - Inhibition rules to prevent alert fatigue - Testing and silencing commands - Multiple receiver configurations All examples are copy-paste ready with realistic values.
- Infrastructure agent installation and setup - Prometheus integration configuration - Kubernetes deployment examples - Remote write configuration with queue settings - Comprehensive NRQL query examples - Alert condition configurations - Terraform automation for alerts and policies - Dashboard creation via API examples
- Keep Antora build/ directory ignore - Merge in Terraform-related ignores from upstream - Keep .claude ignore from upstream
- Add prominent links to production-ready configs in GitHub repo - Include direct links to alert rules, dashboards, and complete configurations - Add helpful tips encouraging users to download/customize rather than start from scratch - Covers Prometheus, Grafana, New Relic, Dynatrace, and Splunk platforms Related to redis-field-engineering#75
@joshrotenberg - does this require the |
No! Removed.
Good call. I'll restructure for that. |
Overview
This PR introduces an Antora-based documentation site as an alternative to the MkDocs implementation in #65.
What's Changed
Documentation Structure
npm run docs
)Latest Updates
Why Antora?
The team expressed preference for Antora over MkDocs. Antora offers:
How to Build
Documentation Structure
Key Features
Next Steps
Related