Commit 7d34c98
authored
docs: add comprehensive presentation outline and rladmin comparison (#415)
* docs: add comprehensive presentation outline and rladmin comparison
Add finalized presentation materials:
PRESENTATION_OUTLINE.md:
- Complete 20-25 minute presentation flow
- Four-layer architecture walkthrough (Raw API → Human → Workflows → Tools)
- Live demo sections with code examples
- Time allocations for each section
- Q&A preparation
- Key takeaways
RLADMIN_COMPARISON.md:
- Comprehensive feature matrix (30+ features)
- Side-by-side comparison of rladmin vs redisctl enterprise
- Use case guidance (when to use each)
- Example comparisons for common tasks
- Conclusion: complementary tools
Presentation flow:
1. Current state (Cloud UI/TF, Enterprise rladmin/API)
2. The problem (no CLI existed)
3. Enter redisctl (first CLI tool)
4. Setup and profiles
5. Four-layer architecture deep dive
6. Advanced features (JMESPath, streaming, support packages)
7. rladmin comparison
8. Library architecture (platform vision)
9. Live demo
10. Roadmap and call to action
Related: #412 (presentation planning)
* 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)
* docs: restructure walkthrough as multi-page presentation
Transform walkthrough into presentation-style format:
- Each page is a presentation slide
- Navigate with arrow keys or sidebar
- Can be used as speaker notes during presentations
- Also works as self-guided tutorial
Structure (10 pages + appendix):
1. The Problem - Current state, why redisctl exists
2. Enter redisctl - First CLI tool, key benefits
3. Installation & Setup - Get started, profiles
4. Raw API Layer - Direct REST access
5. Human-Friendly Layer - Better UX, type-safe
6. Workflows Layer - Multi-step orchestration
7. Advanced Features - JMESPath, support packages, streaming
8. Library Architecture - Platform vision, reusable components
9. Next Steps - Try it, get involved, roadmap
Appendix - rladmin comparison
Benefits:
- Presentation-friendly navigation (page by page)
- Each page is focused and concise
- Natural flow from problem to solution
- Works for both live presentations and self-study
- Links to deep-dive documentation
Duration: 20-25 minutes as presentation, 45-60 minutes hands-on
* docs: add rladmin vs redisctl comparison to documentation
- Create new Comparison section in docs
- Add comprehensive rladmin vs redisctl feature comparison
- Include practical examples and use cases
- Show that tools are complementary, not competing
- Link to planned enhancement issues (#417-420)
Closes #423
* feat(enterprise): add comprehensive status command
Add 'status' command that displays cluster, nodes, databases, and shards
in a single view, similar to rladmin's 'status extra all' command.
Features:
- Single command shows all cluster information
- Optional section filtering (--cluster, --nodes, --databases, --shards)
- Calculates summary statistics (health, totals, active counts)
- Supports JSON, YAML, and table output formats
- Works with JMESPath queries for filtering
- Sequential API calls for simplicity and reliability
Also fixed:
- Shard.node_uid type changed from u32 to String (matches API response)
Closes #420
* fix: update shard tests and suppress false dead code warnings
- Fix shard tests to use String for node_uid (matches API response)
- Update mock data in shard_tests.rs (node_uid: 1 -> "1")
- Update test assertions to compare with strings
- Add #[allow(dead_code)] to status.rs structs/functions
(they are used via main.rs routing but clippy doesn't detect it)
All tests now pass:
- cargo test --lib --all-features ✓
- cargo test --test '*' --all-features ✓
- cargo clippy --all-targets --all-features ✓
- cargo fmt --all -- --check ✓
* docs: simplify walkthrough structure and add clean demo script
- Flatten walkthrough navigation (8, 8.1, 8.2, etc. instead of separate top-level items)
- Create DEMO.md with clean copy-paste commands for live presentation
- Organized by demo flow: problem -> solution -> features -> automation
- Includes setup, recovery commands, and talking points
- Commands tested and ready to run
This makes the presentation cleaner and gives you a reliable script
to practice and present from.
* feat: add --config-file flag for alternate configuration file (#430)
- Add --config-file global flag and REDISCTL_CONFIG_FILE environment variable
- Add Config::load_from_path() and Config::save_to_path() methods
- Update ConnectionManager to track and use alternate config path
- Update all profile commands to save to the correct location
- Tested with both flag and environment variable
Closes #428
* docs: fix brew tap command and set mdbook folding to closed by default
- Change brew tap from joshrotenberg/tap to joshrotenberg/brew
- Set mdbook fold level to 0 (closed by default)
* docs: add credential priority documentation and fix brew tap command
- Add credential hierarchy section to troubleshooting
- Add credential priority to profile setup docs
- Fix brew tap command to joshrotenberg/brew
- Set mdbook fold level to 0 (closed by default)
- Update DEMO.md profile commands to use --deployment flag1 parent 2f5c6a3 commit 7d34c98
File tree
25 files changed
+2836
-169
lines changed- crates
- redis-enterprise
- src
- tests
- redisctl/src
- commands/enterprise
- docs
- src
- comparison
- reference
- walkthrough
- examples/presentation
25 files changed
+2836
-169
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
43 | | - | |
| 43 | + | |
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| |||
132 | 132 | | |
133 | 133 | | |
134 | 134 | | |
135 | | - | |
| 135 | + | |
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
| |||
219 | 219 | | |
220 | 220 | | |
221 | 221 | | |
222 | | - | |
| 222 | + | |
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
| |||
252 | 252 | | |
253 | 253 | | |
254 | 254 | | |
255 | | - | |
| 255 | + | |
256 | 256 | | |
257 | 257 | | |
258 | 258 | | |
| |||
453 | 453 | | |
454 | 454 | | |
455 | 455 | | |
456 | | - | |
457 | | - | |
458 | | - | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
459 | 459 | | |
460 | 460 | | |
461 | 461 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1323 | 1323 | | |
1324 | 1324 | | |
1325 | 1325 | | |
| 1326 | + | |
| 1327 | + | |
| 1328 | + | |
| 1329 | + | |
| 1330 | + | |
| 1331 | + | |
| 1332 | + | |
| 1333 | + | |
| 1334 | + | |
| 1335 | + | |
| 1336 | + | |
| 1337 | + | |
| 1338 | + | |
| 1339 | + | |
| 1340 | + | |
| 1341 | + | |
| 1342 | + | |
| 1343 | + | |
| 1344 | + | |
1326 | 1345 | | |
1327 | 1346 | | |
1328 | 1347 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| 38 | + | |
38 | 39 | | |
39 | 40 | | |
40 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
485 | 485 | | |
486 | 486 | | |
487 | 487 | | |
| 488 | + | |
| 489 | + | |
| 490 | + | |
| 491 | + | |
| 492 | + | |
| 493 | + | |
| 494 | + | |
| 495 | + | |
| 496 | + | |
| 497 | + | |
| 498 | + | |
| 499 | + | |
| 500 | + | |
| 501 | + | |
| 502 | + | |
488 | 503 | | |
489 | 504 | | |
490 | 505 | | |
| |||
0 commit comments