Skip to content

Commit 8a1b274

Browse files
joshrotenbergjoshrotenberg
committed
docs: add walkthrough page linking to presentation materials
Add comprehensive walkthrough page to documentation that: - Links to presentation materials in examples/presentation/ - Provides quick overview of the presentation flow - Serves as both presentation script and self-guided tutorial - Can be used for onboarding new users The walkthrough covers: 1. The problem (why redisctl exists) 2. Enter redisctl (first CLI tool) 3. Four-layer architecture 4. Advanced features 5. Library architecture 6. Hands-on tutorial section 7. Links to deep-dive documentation Benefits: - Single source of truth for presentation content - Available in docs for anyone to read later - Links to actual presentation files in repo - Reduces duplication (references existing cookbook/reference docs)
1 parent 5fc37ca commit 8a1b274

File tree

2 files changed

+182
-0
lines changed

2 files changed

+182
-0
lines changed

‎docs/src/SUMMARY.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
- [Shell Completions](./getting-started/shell-completions.md)
1313
- [Quick Start Guide](./getting-started/quickstart.md)
1414

15+
# Complete Walkthrough
16+
17+
- [Overview & Presentation](./walkthrough.md)
18+
1519
# Cookbook
1620

1721
- [Overview](./cookbook/README.md)

‎docs/src/walkthrough.md‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
# Complete Walkthrough & Presentation
2+
3+
This page provides a comprehensive walkthrough of redisctl, suitable for:
4+
- **Team presentations** - Follow as a speaker script
5+
- **Self-guided learning** - Work through at your own pace
6+
- **Onboarding** - Get new team members up to speed
7+
8+
## Presentation Materials
9+
10+
The complete presentation outline and supporting materials are available in the repository:
11+
12+
📁 **[examples/presentation/](https://github.com/joshrotenberg/redisctl/tree/main/examples/presentation)**
13+
14+
### Files
15+
16+
- **[PRESENTATION_OUTLINE.md](https://github.com/joshrotenberg/redisctl/blob/main/examples/presentation/PRESENTATION_OUTLINE.md)** - Complete 20-25 minute presentation
17+
- Slide-by-slide walkthrough
18+
- Speaking notes and timing
19+
- Code examples
20+
- Q&A preparation
21+
22+
- **[RLADMIN_COMPARISON.md](https://github.com/joshrotenberg/redisctl/blob/main/examples/presentation/RLADMIN_COMPARISON.md)** - Feature matrix comparing rladmin vs redisctl
23+
24+
- **Demo Scripts**:
25+
- `01-before-redisctl.sh` - The painful reality (curl + jq + polling)
26+
- `02-after-redisctl.sh` - The elegant solution
27+
- `03-demo-workflow.sh` - Complete feature showcase
28+
29+
## Quick Overview
30+
31+
### 1. The Problem (Why redisctl exists)
32+
33+
**Redis Cloud:**
34+
- Web UI only (not scriptable)
35+
- Terraform provider (good for IaC, not ad-hoc ops)
36+
- No CLI for day-to-day operations
37+
38+
**Redis Enterprise:**
39+
- **rladmin** - Node-local CLI, requires SSH, text output
40+
- REST API - Large, complex, poorly documented
41+
- No remote CLI, no automation-friendly tools
42+
43+
**Result:** Everyone writes fragile bash + curl + jq scripts
44+
45+
### 2. Enter redisctl
46+
47+
**The FIRST command-line tool for both Redis Cloud and Redis Enterprise**
48+
49+
Key features:
50+
- Type-safe API clients
51+
- Automatic async operation handling (`--wait`)
52+
- Support package automation (10 min → 30 sec)
53+
- Profile management with secure keyring
54+
- Structured output (JSON, YAML, Table)
55+
- Library-first architecture
56+
57+
### 3. Four-Layer Architecture
58+
59+
redisctl provides four layers of interaction:
60+
61+
**Layer 1: Raw API Access**
62+
```bash
63+
# Direct REST calls to any endpoint
64+
redisctl api cloud get /subscriptions
65+
redisctl api enterprise get /v1/cluster
66+
```
67+
68+
**Layer 2: Human-Friendly Commands**
69+
```bash
70+
# Better UX with type-safe parameters
71+
redisctl cloud subscription list -o table
72+
redisctl enterprise database list
73+
```
74+
75+
**Layer 3: Workflows**
76+
```bash
77+
# Multi-step orchestrated operations
78+
redisctl enterprise workflow init-cluster \
79+
--cluster-name "production" \
80+
--username "[email protected]"
81+
```
82+
83+
**Layer 4: Specialized Tools**
84+
```bash
85+
# Support package automation
86+
redisctl enterprise support-package cluster \
87+
--optimize \
88+
--upload
89+
```
90+
91+
### 4. Advanced Features
92+
93+
- **JMESPath queries** - Filter and transform output
94+
- **Log streaming** - Real-time with `--follow`
95+
- **Multiple output formats** - JSON, YAML, Table
96+
- **Profile system** - Manage multiple clusters
97+
- **License management** - For Enterprise clusters
98+
99+
### 5. Library Architecture
100+
101+
redisctl is built as reusable libraries:
102+
103+
```
104+
├── redisctl-config # Profile/credential management
105+
├── redis-cloud # Cloud API client (21 handlers)
106+
├── redis-enterprise # Enterprise API client (29 handlers)
107+
└── redisctl # CLI binary
108+
```
109+
110+
This enables:
111+
- Terraform providers
112+
- Custom automation tools
113+
- Monitoring integrations
114+
- Backup/migration utilities
115+
116+
## Hands-On Tutorial
117+
118+
### Prerequisites
119+
120+
For hands-on practice with Enterprise features:
121+
122+
```bash
123+
# Start local Redis Enterprise cluster
124+
docker compose up -d
125+
126+
# Verify it's running
127+
docker compose ps
128+
```
129+
130+
### Try the Demo Scripts
131+
132+
```bash
133+
# Clone the repository
134+
git clone https://github.com/joshrotenberg/redisctl
135+
cd redisctl/examples/presentation
136+
137+
# Run the demos
138+
./01-before-redisctl.sh # See the problem
139+
./02-after-redisctl.sh # See the solution
140+
./03-demo-workflow.sh # Complete showcase
141+
```
142+
143+
## Deep Dive Sections
144+
145+
For detailed information on specific topics:
146+
147+
- **Installation** - See [Installation Guide](./getting-started/installation.md)
148+
- **Profile Setup** - See [Configuration Guide](./getting-started/configuration.md)
149+
- **Cloud Operations** - See [Cloud Cookbook](./cookbook/README.md#redis-cloud-recipes)
150+
- **Enterprise Operations** - See [Enterprise Cookbook](./cookbook/README.md#redis-enterprise-recipes)
151+
- **API Reference** - See [Cloud Commands](./cloud/commands.md) and [Enterprise Commands](./enterprise/README.md)
152+
153+
## Presentation Tips
154+
155+
If you're using this as a presentation script:
156+
157+
1. **Start with the problem** - Show `01-before-redisctl.sh` first
158+
2. **Emphasize "FIRST CLI"** - Neither Cloud nor Enterprise had one
159+
3. **Demo the four layers** - Show progression from raw to workflows
160+
4. **Highlight killer feature** - Support package automation
161+
5. **End with library vision** - Platform, not just a CLI
162+
163+
**Timing:** 20-25 minutes + Q&A
164+
165+
## Questions & Feedback
166+
167+
- **Issues**: [GitHub Issues](https://github.com/joshrotenberg/redisctl/issues)
168+
- **Discussions**: Start a discussion in the repository
169+
- **API Docs**: [docs.rs/redisctl](https://docs.rs/redisctl)
170+
171+
## What's Next?
172+
173+
After this walkthrough, explore:
174+
175+
- **[Cookbook](./cookbook/README.md)** - Task-oriented recipes
176+
- **[Cloud Reference](./cloud/overview.md)** - Complete Cloud API coverage
177+
- **[Enterprise Reference](./enterprise/overview.md)** - Complete Enterprise API coverage
178+
- **[Developer Guide](./developer/library-usage.md)** - Build with redisctl libraries

0 commit comments

Comments
 (0)