Skip to content

Commit f3d232e

Browse files
slorello89slorello89
authored
Merge pull request #74 from joshrotenberg/antora-docs
Add Antora-based documentation site
2 parents 10997cc + ec366d7 commit f3d232e

23 files changed

+5465
-3
lines changed

‎.github/workflows/deploy-docs.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Antora Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'antora-playbook.yml'
10+
- '.github/workflows/deploy-docs.yml'
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout repository
27+
uses: actions/checkout@v4
28+
29+
- name: Setup Node.js
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: '20'
33+
cache: 'npm'
34+
35+
- name: Install dependencies
36+
run: npm ci
37+
38+
- name: Build Antora site
39+
run: npm run docs
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: ./build/site
45+
46+
deploy:
47+
environment:
48+
name: github-pages
49+
url: ${{ steps.deployment.outputs.page_url }}
50+
runs-on: ubuntu-latest
51+
needs: build
52+
steps:
53+
- name: Deploy to GitHub Pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,16 @@ logs
1212
# Lock files
1313
*.lock
1414

15+
# Node modules
16+
node_modules/
17+
1518
playbook/target
1619

1720
.vscode
21+
22+
# Antora build output
23+
build/
24+
1825
.tfvars
1926

2027
# Local .terraform directories
@@ -29,8 +36,8 @@ crash.log
2936
crash.*.log
3037

3138
# Exclude all .tfvars files, which are likely to contain sensitive data, such as
32-
# password, private keys, and other secrets. These should not be part of version
33-
# control as they are data points which are potentially sensitive and subject
39+
# password, private keys, and other secrets. These should not be part of version
40+
# control as they are data points which are potentially sensitive and subject
3441
# to change depending on the environment.
3542
*.tfvars
3643
*.tfvars.json
@@ -44,4 +51,4 @@ override.tf.json
4451

4552
# Ignore transient lock info files created by terraform apply
4653
.terraform.tfstate.lock.info
47-
.claude
54+
.claude

‎README.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Redis Enterprise Observability
2+
3+
Comprehensive monitoring and observability solutions for Redis Enterprise deployments.
4+
5+
## Overview
6+
7+
This repository provides pre-built dashboards, metrics configurations, and integration guides for monitoring Redis Enterprise across multiple observability platforms.
8+
9+
## Supported Platforms
10+
11+
- **Grafana** - Visualization and analytics
12+
- **Prometheus** - Metrics collection and time-series storage
13+
- **Dynatrace** - Full-stack monitoring
14+
- **New Relic** - Application performance monitoring
15+
- **Splunk** - Log analytics and SIEM
16+
- **Kibana** - Elasticsearch visualization
17+
18+
## Documentation
19+
20+
📚 **[View the complete documentation](https://redis-field-engineering.github.io/redis-enterprise-observability/)**
21+
22+
The documentation includes:
23+
- Quick start guides
24+
- Platform-specific integration instructions
25+
- Dashboard catalog
26+
- Monitoring best practices
27+
- Alerting configuration
28+
- Metrics reference
29+
- Troubleshooting guides
30+
31+
### Building Documentation Locally
32+
33+
```bash
34+
# Install dependencies
35+
npm install
36+
37+
# Generate documentation site
38+
npm run docs
39+
40+
# View the site
41+
open build/site/index.html
42+
43+
# Or serve locally
44+
npm run docs:serve
45+
# Visit http://localhost:8080
46+
```
47+
48+
## Quick Start
49+
50+
1. Choose your observability platform
51+
2. Follow the platform-specific guide in the [documentation](https://redis-field-engineering.github.io/redis-enterprise-observability/)
52+
3. Import pre-built dashboards from the catalog
53+
4. Configure alerting based on your requirements
54+
55+
## Repository Structure
56+
57+
```
58+
.
59+
├── docs/ # Antora documentation source
60+
│ ├── antora.yml # Component descriptor
61+
│ └── modules/ROOT/
62+
│ ├── pages/ # Documentation pages (AsciiDoc)
63+
│ └── nav.adoc # Navigation menu
64+
├── grafana/ # Grafana dashboards
65+
├── prometheus/ # Prometheus configurations
66+
├── dynatrace/ # Dynatrace integrations
67+
├── newrelic/ # New Relic dashboards
68+
├── splunk/ # Splunk configurations
69+
└── kibana/ # Kibana dashboards
70+
```
71+
72+
## Contributing
73+
74+
Contributions are welcome! Please:
75+
76+
1. Fork the repository
77+
2. Create a feature branch
78+
3. Make your changes
79+
4. Submit a pull request
80+
81+
For documentation contributions, see [docs/README.md](docs/README.md).
82+
83+
## Resources
84+
85+
- [Redis Enterprise Documentation](https://docs.redis.com/latest/rs/)
86+
- [Redis Cloud Documentation](https://docs.redis.com/latest/rc/)
87+
- [Antora Documentation](https://docs.antora.org/)
88+
89+
## License
90+
91+
See [LICENSE](LICENSE) for details.

‎antora-playbook.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
site:
2+
title: Redis Enterprise Observability
3+
start_page: redis-enterprise-observability::index.adoc
4+
url: https://redis-field-engineering.github.io/redis-enterprise-observability
5+
6+
content:
7+
sources:
8+
- url: .
9+
branches: HEAD
10+
start_path: docs
11+
12+
ui:
13+
bundle:
14+
url: https://github.com/redis/antora-ui-redis/releases/latest/download/ui-bundle.zip
15+
snapshot: true
16+
supplemental_files:
17+
- path: ui.yml
18+
contents: |
19+
static_files:
20+
- .nojekyll
21+
- path: .nojekyll
22+
23+
output:
24+
dir: ./build/site

‎docs/README.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Redis Enterprise Observability Documentation
2+
3+
This directory contains the Antora-based documentation for Redis Enterprise Observability.
4+
5+
## Building the Documentation
6+
7+
### Prerequisites
8+
9+
- Node.js (LTS version recommended)
10+
- npm
11+
12+
### Build Commands
13+
14+
```bash
15+
# Install dependencies (if not already installed)
16+
npm install
17+
18+
# Generate documentation site
19+
npm run docs
20+
21+
# Serve the site locally (requires http-server)
22+
npm run docs:serve
23+
```
24+
25+
The generated site will be available at `build/site/index.html` or http://localhost:8080 when using the serve command.
26+
27+
## Documentation Structure
28+
29+
The documentation follows Antora's standard structure:
30+
31+
```
32+
docs/
33+
├── antora.yml # Component descriptor
34+
└── modules/
35+
└── ROOT/
36+
├── nav.adoc # Navigation menu
37+
├── pages/ # Documentation pages (AsciiDoc)
38+
│ ├── index.adoc
39+
│ ├── platforms/
40+
│ ├── dashboards/
41+
│ ├── guides/
42+
│ └── reference/
43+
├── images/ # Images and screenshots
44+
├── examples/ # Code examples
45+
└── attachments/ # Downloadable files
46+
```
47+
48+
## Writing Documentation
49+
50+
- Documentation is written in AsciiDoc format (`.adoc` files)
51+
- Place new pages in the appropriate `pages/` subdirectory
52+
- Update `nav.adoc` to add pages to the navigation menu
53+
- Use cross-references with `xref:` to link between pages
54+
55+
## Contributing
56+
57+
1. Add or modify `.adoc` files in `docs/modules/ROOT/pages/`
58+
2. Update navigation in `docs/modules/ROOT/nav.adoc` if adding new pages
59+
3. Build and test locally with `npm run docs`
60+
4. Submit a pull request with your changes
61+
62+
## Resources
63+
64+
- [Antora Documentation](https://docs.antora.org/)
65+
- [AsciiDoc Syntax](https://docs.asciidoctor.org/asciidoc/latest/)

‎docs/antora.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: redis-enterprise-observability
2+
version: latest
3+
title: Redis Enterprise Observability
4+
nav:
5+
- modules/ROOT/nav.adoc

‎docs/modules/ROOT/nav.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
* xref:index.adoc[Overview]
2+
* xref:quick-start.adoc[Quick Start]
3+
4+
.Platforms
5+
* xref:platforms/grafana.adoc[Grafana]
6+
* xref:platforms/prometheus.adoc[Prometheus]
7+
* xref:platforms/dynatrace.adoc[Dynatrace]
8+
* xref:platforms/newrelic.adoc[New Relic]
9+
* xref:platforms/splunk.adoc[Splunk]
10+
* xref:platforms/kibana.adoc[Kibana]
11+
12+
.Dashboards
13+
* xref:dashboards/catalog.adoc[Dashboard Catalog]
14+
15+
.Guides
16+
* xref:guides/monitoring-redis-cloud.adoc[Monitoring Redis Cloud]
17+
* xref:guides/alerting.adoc[Alerting]
18+
* xref:guides/troubleshooting.adoc[Troubleshooting]
19+
20+
.Reference
21+
* xref:reference/metrics.adoc[Metrics Reference]
22+
* xref:reference/configuration.adoc[Configuration]

0 commit comments

Comments
 (0)