Skip to content

Commit a5034af

Browse files
joshrotenbergjoshrotenberg
authored
docs: restructure documentation hierarchy (#456)
* docs: add stub files for restructured hierarchy New structure follows the 3-tier model (API/Commands/Workflows): - Getting Started with common features - Streamlined Walkthrough (3 pages) - Cloud and Enterprise sections with light grouping - Cookbook moved after main docs - Consolidated Reference section * docs: migrate common features content and refine structure - Add comprehensive profiles/authentication docs - Add output formats documentation - Add JMESPath queries documentation - Add async operations documentation - Streamline quickstart to 60-second Docker experience - Move shell completions to Reference - Reorder sections for better flow * docs: complete Cloud section content - Overview with three-tier model explanation - Full API layer documentation - Databases commands (migrated from core-resources) - Subscriptions commands (migrated from core-resources) - Access control (users, roles, ACLs) - Networking (VPC, PSC, Transit Gateway) - Tasks monitoring - Workflows documentation * docs: complete Enterprise section content - Overview with three-tier model explanation - Full API layer documentation - Cluster commands (migrated from core-resources) - Databases commands - Nodes commands - Access control (users, roles, LDAP, ACLs) - Monitoring (stats, logs, alerts) - Active-Active (CRDB) commands - Workflows documentation - Operations overview with quick reference * docs: complete restructure with walkthrough, reference, developer sections - Full walkthrough with overview and quick examples - rladmin comparison in reference - Architecture and contributing docs - Clean up old/orphaned files (60+ removed) - Documentation restructure complete * docs: fix Cloud database command syntax - Use --subscription instead of --subscription-id - Use colon format for database IDs (123456:789) - Fix examples throughout docs * fix(docs): remove fa-github icon for mdbook 0.5 compatibility
1 parent d214749 commit a5034af

File tree

105 files changed

+4221
-12972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+4221
-12972
lines changed

‎docs/book.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ title = "redisctl Documentation"
88
default-theme = "light"
99
preferred-dark-theme = "ayu"
1010
git-repository-url = "https://github.com/joshrotenberg/redisctl"
11-
git-repository-icon = "fa-github"
1211
edit-url-template = "https://github.com/joshrotenberg/redisctl/edit/main/docs/{path}"
1312

1413
[output.html.fold]

‎docs/src/SUMMARY.md‎

Lines changed: 50 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,146 +1,84 @@
11
# Summary
22

3-
[Introduction](./introduction.md)
4-
5-
# Getting Started
3+
# Introduction
64

5+
- [Overview](./introduction.md)
6+
- [Quick Start](./getting-started/quickstart.md)
77
- [Installation](./getting-started/installation.md)
8-
- [Docker Quick Start](./getting-started/docker.md)
9-
- [Configuration](./getting-started/configuration.md)
10-
- [Authentication](./getting-started/authentication.md)
11-
- [Examples](./getting-started/examples.md)
12-
- [Shell Completions](./getting-started/shell-completions.md)
13-
- [Quick Start Guide](./getting-started/quickstart.md)
14-
15-
# Complete Walkthrough
16-
17-
- [8. Introduction](./walkthrough/README.md)
18-
- [8.1 The Problem](./walkthrough/01-problem.md)
19-
- [8.2 Enter redisctl](./walkthrough/02-solution.md)
20-
- [8.3 Installation & Setup](./walkthrough/03-setup.md)
21-
- [8.4 Raw API Layer](./walkthrough/04-raw-api.md)
22-
- [8.5 Human-Friendly Layer](./walkthrough/05-human-friendly.md)
23-
- [8.6 Workflows Layer](./walkthrough/06-workflows.md)
24-
- [8.7 Advanced Features](./walkthrough/07-advanced.md)
25-
- [8.8 Library Architecture](./walkthrough/08-libraries.md)
26-
- [8.9 Next Steps](./walkthrough/09-next-steps.md)
27-
- [8.10 Appendix: rladmin vs redisctl](./walkthrough/rladmin-comparison.md)
288

29-
# Cookbook
9+
# Common Features
3010

31-
- [Overview](./cookbook/README.md)
32-
- [Redis Cloud]()
33-
- [Create Your First Database](./cookbook/cloud/create-first-database.md)
34-
- [Set Up VPC Peering](./cookbook/cloud/setup-vpc-peering.md)
35-
- [Configure ACL Security](./cookbook/cloud/configure-acls.md)
36-
- [Backup and Restore](./cookbook/cloud/backup-restore.md)
37-
- [Database Migration](./cookbook/cloud/database-migration.md)
38-
- [Active-Active Setup](./cookbook/cloud/active-active-setup.md)
39-
- [Redis Enterprise]()
40-
- [Create a Database](./cookbook/enterprise/create-database.md)
41-
- [Generate Support Package](./cookbook/enterprise/support-package.md)
42-
- [Cluster Health Monitoring](./cookbook/enterprise/cluster-health.md)
43-
- [Node Management](./cookbook/enterprise/node-management.md)
44-
- [Configure Replication](./cookbook/enterprise/configure-replication.md)
45-
- [Configure Redis ACLs](./cookbook/enterprise/configure-redis-acls.md)
11+
- [Profiles & Authentication](./common-features/profiles.md)
12+
- [Output Formats](./common-features/output-formats.md)
13+
- [JMESPath Queries](./common-features/jmespath-queries.md)
14+
- [Async Operations](./common-features/async-operations.md)
4615

4716
# Redis Cloud
4817

4918
- [Overview](./cloud/overview.md)
50-
- [Core Resources]()
51-
- [Subscriptions](./cloud/core-resources/subscriptions.md)
52-
- [Databases](./cloud/core-resources/databases.md)
53-
- [Access Control]()
54-
- [Users](./cloud/access-control/users.md)
55-
- [ACLs](./cloud/access-control/acl.md)
56-
- [Networking]()
57-
- [Connectivity (VPC, PSC, TGW)](./cloud/networking/connectivity.md)
58-
- [Operations]()
59-
- [Tasks](./cloud/operations/tasks.md)
60-
- [Workflows](./cloud/operations/workflows.md)
61-
- [Examples](./cloud/examples.md)
62-
- [Human-Friendly Commands](./cloud/human-commands.md)
63-
- [All Commands](./cloud/commands.md)
19+
- [API Layer](./cloud/api.md)
20+
- [Commands]()
21+
- [Databases](./cloud/commands/databases.md)
22+
- [Subscriptions](./cloud/commands/subscriptions.md)
23+
- [Access Control](./cloud/commands/access-control.md)
24+
- [Networking](./cloud/commands/networking.md)
25+
- [Tasks](./cloud/commands/tasks.md)
26+
- [Workflows](./cloud/workflows.md)
6427

6528
# Redis Enterprise
6629

6730
- [Overview](./enterprise/overview.md)
68-
- [Core Resources]()
69-
- [Cluster](./enterprise/core-resources/cluster.md)
70-
- [Databases](./enterprise/core-resources/databases.md)
71-
- [Nodes](./enterprise/core-resources/nodes.md)
72-
- [Shards](./enterprise/core-resources/shards.md)
73-
- [Modules](./enterprise/core-resources/modules.md)
74-
- [Database Groups](./enterprise/core-resources/bdb-groups.md)
75-
- [Access Control]()
76-
- [Users & Roles](./enterprise/access-control/users.md)
77-
- [LDAP Integration](./enterprise/access-control/ldap.md)
78-
- [Active-Active]()
79-
- [CRDB Operations](./enterprise/active-active/crdb.md)
80-
- [CRDB Tasks](./enterprise/active-active/crdb-tasks.md)
81-
- [Monitoring]()
82-
- [Statistics](./enterprise/monitoring/stats.md)
83-
- [Logs](./enterprise/monitoring/logs.md)
84-
- [Alerts](./enterprise/monitoring/alerts.md)
85-
- [Usage Reports](./enterprise/monitoring/usage-report.md)
86-
- [Operations]()
31+
- [API Layer](./enterprise/api.md)
32+
- [Commands]()
33+
- [Cluster](./enterprise/commands/cluster.md)
34+
- [Databases](./enterprise/commands/databases.md)
35+
- [Nodes](./enterprise/commands/nodes.md)
36+
- [Access Control](./enterprise/commands/access-control.md)
37+
- [Monitoring](./enterprise/commands/monitoring.md)
38+
- [Active-Active](./enterprise/commands/active-active.md)
39+
- [Workflows](./enterprise/workflows.md)
40+
- [Operations](./enterprise/operations.md)
8741
- [Support Package](./enterprise/operations/support-package.md)
42+
- [License Management](./enterprise/operations/license.md)
8843
- [Debug Info](./enterprise/operations/debuginfo.md)
8944
- [Diagnostics](./enterprise/operations/diagnostics.md)
90-
- [License Management](./enterprise/operations/license.md)
9145
- [Migrations](./enterprise/operations/migration.md)
92-
- [Advanced]()
93-
- [Actions](./enterprise/advanced/actions.md)
94-
- [Workflows](./enterprise/advanced/workflows.md)
95-
- [Job Scheduler](./enterprise/advanced/job-scheduler.md)
96-
- [Bootstrap](./enterprise/advanced/bootstrap.md)
97-
- [Proxies](./enterprise/advanced/proxy.md)
98-
- [Endpoints](./enterprise/advanced/endpoints.md)
99-
- [Services](./enterprise/advanced/services.md)
100-
- [CM Settings](./enterprise/advanced/cm-settings.md)
101-
- [OCSP](./enterprise/advanced/ocsp.md)
102-
- [DNS Suffix](./enterprise/advanced/suffix.md)
103-
- [JSON Schema](./enterprise/advanced/jsonschema.md)
104-
- [Examples](./enterprise/examples.md)
105-
- [Human-Friendly Commands](./enterprise/human-commands.md)
106-
- [All Commands](./enterprise/commands.md)
107-
- [API Access](./enterprise/api-access.md)
10846

109-
# Common Features
47+
# Walkthrough
11048

111-
- [Output Formats](./common-features/output-formats.md)
112-
- [JMESPath Queries](./common-features/jmespath-queries.md)
113-
- [Async Operations](./common-features/async-operations.md)
114-
- [Raw API Access](./common-features/raw-api.md)
115-
- [Secure Storage](./common-features/secure-storage.md)
49+
- [Overview & Concepts](./walkthrough/overview.md)
50+
- [Cloud Quick Examples](./walkthrough/cloud-examples.md)
51+
- [Enterprise Quick Examples](./walkthrough/enterprise-examples.md)
11652

117-
# Comparison
118-
119-
- [rladmin vs redisctl](./comparison/rladmin.md)
120-
121-
# Tutorials
53+
# Cookbook
12254

123-
- [CI/CD Integration](./tutorials/cicd.md)
124-
- [Common Recipes](./tutorials/common-recipes.md)
125-
- [Disaster Recovery](./tutorials/disaster-recovery.md)
126-
- [Monitoring Setup](./tutorials/monitoring.md)
127-
- [Network Security](./tutorials/network-security.md)
128-
- [Production Databases](./tutorials/production-databases.md)
55+
- [Overview](./cookbook/README.md)
56+
- [Redis Cloud]()
57+
- [Create Your First Database](./cookbook/cloud/create-first-database.md)
58+
- [Set Up VPC Peering](./cookbook/cloud/setup-vpc-peering.md)
59+
- [Configure ACL Security](./cookbook/cloud/configure-acls.md)
60+
- [Backup and Restore](./cookbook/cloud/backup-restore.md)
61+
- [Database Migration](./cookbook/cloud/database-migration.md)
62+
- [Active-Active Setup](./cookbook/cloud/active-active-setup.md)
63+
- [Redis Enterprise]()
64+
- [Create a Database](./cookbook/enterprise/create-database.md)
65+
- [Generate Support Package](./cookbook/enterprise/support-package.md)
66+
- [Cluster Health Monitoring](./cookbook/enterprise/cluster-health.md)
67+
- [Node Management](./cookbook/enterprise/node-management.md)
68+
- [Configure Replication](./cookbook/enterprise/configure-replication.md)
69+
- [Configure Redis ACLs](./cookbook/enterprise/configure-redis-acls.md)
12970

13071
# Reference
13172

13273
- [Environment Variables](./reference/environment-variables.md)
13374
- [Configuration File](./reference/config-file.md)
75+
- [Shell Completions](./reference/shell-completions.md)
13476
- [Security](./reference/security.md)
135-
- [Best Practices](./reference/best-practices.md)
13677
- [Troubleshooting](./reference/troubleshooting.md)
137-
138-
# API Reference
139-
140-
- [API Overview](./api-reference/api.md)
78+
- [rladmin Comparison](./reference/rladmin.md)
14179

14280
# Developer
14381

14482
- [Architecture](./developer/architecture.md)
14583
- [Libraries](./developer/libraries.md)
146-
- [Contributing](./developer/contributing.md)
84+
- [Contributing](./developer/contributing.md)

0 commit comments

Comments
 (0)