Skip to content

Commit 0e9a6e5

Browse files
committed
docs: sync presentation outline with walkthrough and add first-class parameters
Update presentation materials to be fully synced with the mdBook walkthrough: PRESENTATION_OUTLINE.md: - Add note directing to walkthrough as primary presentation source - Add walkthrough links to each section for easy navigation - Keep outline as speaker notes, timing guide, and Q&A prep docs/src/walkthrough/02-solution.md: - Update examples to showcase first-class parameters - Add metrics: 225 tests, first-class parameters feature - Update version: v0.6.5 → v0.6.6 docs/src/walkthrough/05-human-friendly.md: - Add new "First-Class Parameters" section at the top - Show before/after comparison (70% typing reduction) - Update all database creation examples to use clean CLI flags - Keep JSON examples as alternative for complex configs - Update --wait examples with new syntax This ensures consistency between all presentation materials and makes the walkthrough the single source of truth for content while keeping the outline useful for speaker preparation.
1 parent 272aca0 commit 0e9a6e5

File tree

3 files changed

+73
-4
lines changed

3 files changed

+73
-4
lines changed

docs/src/walkthrough/02-solution.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@ A unified CLI that eliminates fragile bash scripts with:
2020
curl + jq + while loops + manual polling + text parsing
2121
```
2222
23-
**After: One Command**
23+
**After: One Simple Command**
2424
```bash
25+
# Clean CLI with first-class parameters (v0.6.6+)
26+
redisctl cloud database create \
27+
--subscription 12345 \
28+
--name mydb \
29+
--memory 1 \
30+
--wait
31+
32+
# Or use JSON for complex configs
2533
redisctl cloud database create \
2634
--subscription 12345 \
2735
--data '{"name": "mydb", "memoryLimitInGb": 1}' \
@@ -48,9 +56,11 @@ redisctl cloud database create \
4856
## Metrics
4957
5058
- 50+ API handlers (21 Cloud + 29 Enterprise)
59+
- 225 comprehensive CLI tests (+217% coverage increase)
5160
- 85%+ test coverage
61+
- First-class parameters for common operations
5262
- Cross-platform (macOS, Linux, Windows)
53-
- v0.6.5 released and actively maintained
63+
- v0.6.6 released and actively maintained
5464
5565
## The Impact
5666

docs/src/walkthrough/05-human-friendly.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,31 @@
66

77
Better experience for day-to-day operations with type-safe parameters, automatic error handling, and progress indicators.
88

9+
## First-Class Parameters (v0.6.6+)
10+
11+
**Before: JSON strings required**
12+
```bash
13+
# Old way - easy to mess up!
14+
redisctl enterprise database create \
15+
--data '{"name":"mydb","memory_size":1073741824,"replication":true}'
16+
```
17+
18+
**After: Clean CLI parameters**
19+
```bash
20+
# New way - simple and validated
21+
redisctl enterprise database create \
22+
--name mydb \
23+
--memory 1073741824 \
24+
--replication
25+
```
26+
27+
**Key improvements:**
28+
- 70% less typing for common operations
29+
- No JSON syntax errors
30+
- Tab completion works
31+
- Better error messages
32+
- Still supports `--data` for complex configs
33+
934
## Cloud Operations
1035

1136
```bash
@@ -34,7 +59,14 @@ redisctl enterprise cluster get \
3459
redisctl enterprise database list \
3560
-o json -q '[].{uid: uid, name: name, port: port, status: status}'
3661

37-
# Create database (as shown in docker-compose)
62+
# Create database - clean CLI parameters
63+
redisctl enterprise database create \
64+
--name cache-db \
65+
--memory 104857600 \
66+
--port 12001 \
67+
-o json -q '{uid: uid, name: name, port: port, status: status}'
68+
69+
# Or with JSON for complex configs
3870
redisctl enterprise database create \
3971
--data '{"name": "cache-db", "memory_size": 104857600, "port": 12001}' \
4072
-o json -q '{uid: uid, name: name, port: port, status: status}'
@@ -70,7 +102,14 @@ redisctl enterprise database get 1 -o yaml
70102
The `--wait` flag automatically polls until operations complete:
71103

72104
```bash
73-
# Create and wait for completion
105+
# Create and wait for completion - new clean syntax
106+
redisctl cloud database create \
107+
--subscription 12345 \
108+
--name mydb \
109+
--memory 1 \
110+
--wait
111+
112+
# Or with JSON for complex configs
74113
redisctl cloud database create \
75114
--subscription 12345 \
76115
--data '{"name": "mydb", "memoryLimitInGb": 1}' \

examples/presentation/PRESENTATION_OUTLINE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44
**Audience:** Technical team (engineers, architects)
55
**Goal:** Introduce redisctl as the first CLI tool for Redis management
66

7+
> **📖 Primary Presentation Source:** Use `docs/src/walkthrough/` (mdBook) for the actual presentation.
8+
> This outline provides speaker notes, timing, and Q&A preparation.
9+
> The walkthrough is navigable, polished, and keeps content synced in one place.
10+
711
---
812

913
## 1. Current State of Redis Management (3 min)
1014

15+
> **📖 Walkthrough:** [1. The Problem](../../docs/src/walkthrough/01-problem.md)
16+
1117
### Redis Cloud
1218
- REST API exists but not widely used directly
1319
- Primary interfaces:
@@ -43,6 +49,8 @@
4349

4450
## 2. Enter redisctl (2 min)
4551

52+
> **📖 Walkthrough:** [2. Enter redisctl](../../docs/src/walkthrough/02-solution.md)
53+
4654
**The FIRST command-line tool for both Redis Cloud and Redis Enterprise**
4755

4856
### Key Value Propositions
@@ -61,6 +69,8 @@
6169

6270
## 3. Installation & Setup (2 min)
6371

72+
> **📖 Walkthrough:** [3. Installation & Setup](../../docs/src/walkthrough/03-setup.md)
73+
6474
### Installation
6575

6676
```bash
@@ -103,6 +113,8 @@ redisctl profile list
103113

104114
## 4. Four-Layer Architecture (5 min)
105115

116+
> **📖 Walkthrough:** [4. Raw API](../../docs/src/walkthrough/04-raw-api.md)[5. Human-Friendly](../../docs/src/walkthrough/05-human-friendly.md)[6. Workflows](../../docs/src/walkthrough/06-workflows.md)[7. Advanced](../../docs/src/walkthrough/07-advanced.md)
117+
106118
### Layer 1: Raw API Access
107119

108120
**Use case:** Any endpoint, full control
@@ -233,6 +245,8 @@ ls -lh demo-package*.tar.gz
233245

234246
## 5. Recent UX Improvements (3 min)
235247

248+
> **📖 Walkthrough:** [5. Human-Friendly Commands](../../docs/src/walkthrough/05-human-friendly.md) (First-Class Parameters section)
249+
236250
### First-Class Parameters (NEW in v0.6.6)
237251

238252
**The Problem with JSON strings:**
@@ -361,6 +375,8 @@ redisctl enterprise license set --key "license-string"
361375

362376
## 7. rladmin Comparison (2 min)
363377

378+
> **📖 Walkthrough:** [Appendix: rladmin Comparison](../../docs/src/walkthrough/rladmin-comparison.md)
379+
364380
**Quick comparison:** (Show `RLADMIN_COMPARISON.md`)
365381

366382
### Where redisctl Excels Over rladmin
@@ -382,6 +398,8 @@ redisctl enterprise license set --key "license-string"
382398

383399
## 8. Library Architecture (2 min)
384400

401+
> **📖 Walkthrough:** [8. Library Architecture](../../docs/src/walkthrough/08-libraries.md)
402+
385403
**redisctl isn't just a CLI - it's a platform**
386404

387405
### Current Libraries
@@ -464,6 +482,8 @@ Showcases:
464482

465483
## 11. Roadmap & Future (2 min)
466484

485+
> **📖 Walkthrough:** [9. Next Steps](../../docs/src/walkthrough/09-next-steps.md)
486+
467487
### Near Term
468488
- Additional workflows (see issues #263-#268)
469489
- Enhanced streaming (metrics, events - #405)

0 commit comments

Comments
 (0)