Skip to content

Commit a4b9e70

Browse files
committed
docs: reorganize documentation structure for better navigation
- Group commands by functionality instead of flat lists - Separate Cloud and Enterprise sections with logical subsections - Move common features to dedicated section - Add comprehensive examples in getting-started - Add JMESPath queries and secure storage documentation - Fix broken internal links throughout - Temporarily disable mdbook-lint during reorganization Addresses issue #361
1 parent ac70b8e commit a4b9e70

Some content is hidden

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

59 files changed

+799
-1718
lines changed

docs/book.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ edit-url-template = "https://github.com/joshrotenberg/redisctl/edit/main/docs/{p
1515
enable = true
1616
level = 1
1717

18-
[preprocessor.lint]
19-
command = "mdbook-lint"
20-
renderer = ["html"]
18+
# Temporarily disabled for reorganization
19+
# [preprocessor.lint]
20+
# command = "mdbook-lint"
21+
# renderer = ["html"]

docs/src/SUMMARY.md

Lines changed: 75 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -5,89 +5,106 @@
55
# Getting Started
66

77
- [Installation](./getting-started/installation.md)
8+
- [Docker Quick Start](./getting-started/docker.md)
89
- [Configuration](./getting-started/configuration.md)
9-
- [Quick Start](./getting-started/quickstart.md)
1010
- [Authentication](./getting-started/authentication.md)
11+
- [Examples](./getting-started/examples.md)
1112
- [Shell Completions](./getting-started/shell-completions.md)
12-
- [Docker Development](./getting-started/docker.md)
13+
- [Quick Start Guide](./getting-started/quickstart.md)
1314

14-
# Redis Cloud Commands
15+
# Redis Cloud
1516

1617
- [Overview](./cloud/overview.md)
17-
- [Subscriptions](./cloud/subscriptions.md)
18-
- [Databases](./cloud/databases.md)
19-
- [Network Connectivity](./cloud/connectivity.md)
20-
- [Access Control](./cloud/acl.md)
21-
- [Users](./cloud/users.md)
22-
- [Provider Accounts](./cloud/provider-accounts.md)
23-
- [Tasks](./cloud/tasks.md)
24-
- [Workflows](./cloud/workflows.md)
25-
- [Raw API Access](./cloud/api-access.md)
18+
- [Core Resources]()
19+
- [Subscriptions](./cloud/core-resources/subscriptions.md)
20+
- [Databases](./cloud/core-resources/databases.md)
21+
- [Access Control]()
22+
- [Users](./cloud/access-control/users.md)
23+
- [ACLs](./cloud/access-control/acl.md)
24+
- [Networking]()
25+
- [Connectivity (VPC, PSC, TGW)](./cloud/networking/connectivity.md)
26+
- [Operations]()
27+
- [Tasks](./cloud/operations/tasks.md)
28+
- [Workflows](./cloud/operations/workflows.md)
2629
- [Examples](./cloud/examples.md)
30+
- [Human-Friendly Commands](./cloud/human-commands.md)
31+
- [All Commands](./cloud/commands.md)
2732

28-
# Redis Enterprise Commands
33+
# Redis Enterprise
2934

3035
- [Overview](./enterprise/overview.md)
31-
- [Cluster](./enterprise/cluster.md)
32-
- [Bootstrap](./enterprise/bootstrap.md)
33-
- [CM Settings](./enterprise/cm-settings.md)
34-
- [Databases](./enterprise/databases.md)
35-
- [Database Groups](./enterprise/bdb-groups.md)
36-
- [Shards](./enterprise/shards.md)
37-
- [Nodes](./enterprise/nodes.md)
38-
- [Proxy Management](./enterprise/proxy.md)
39-
- [Users & RBAC](./enterprise/users.md)
40-
- [Statistics](./enterprise/stats.md)
41-
- [Usage Reports](./enterprise/usage-report.md)
42-
- [Modules](./enterprise/modules.md)
43-
- [Logs](./enterprise/logs.md)
44-
- [Database Migration](./enterprise/migration.md)
45-
- [Active-Active (CRDB)](./enterprise/crdb.md)
46-
- [CRDB Tasks](./enterprise/crdb-tasks.md)
47-
- [Actions (Tasks)](./enterprise/actions.md)
48-
- [Alerts](./enterprise/alerts.md)
49-
- [Debug Info](./enterprise/debuginfo.md)
50-
- [Diagnostics](./enterprise/diagnostics.md)
51-
- [Endpoints](./enterprise/endpoints.md)
52-
- [Job Scheduler](./enterprise/job-scheduler.md)
53-
- [JSON Schema](./enterprise/jsonschema.md)
54-
- [LDAP Integration](./enterprise/ldap.md)
55-
- [License Management](./enterprise/license.md)
56-
- [OCSP Validation](./enterprise/ocsp.md)
57-
- [Service Management](./enterprise/services.md)
58-
- [DNS Suffixes](./enterprise/suffix.md)
59-
- [Workflows](./enterprise/workflows.md)
60-
- [Raw API Access](./enterprise/api-access.md)
36+
- [Core Resources]()
37+
- [Cluster](./enterprise/core-resources/cluster.md)
38+
- [Databases](./enterprise/core-resources/databases.md)
39+
- [Nodes](./enterprise/core-resources/nodes.md)
40+
- [Shards](./enterprise/core-resources/shards.md)
41+
- [Modules](./enterprise/core-resources/modules.md)
42+
- [Database Groups](./enterprise/core-resources/bdb-groups.md)
43+
- [Access Control]()
44+
- [Users & Roles](./enterprise/access-control/users.md)
45+
- [LDAP Integration](./enterprise/access-control/ldap.md)
46+
- [Active-Active]()
47+
- [CRDB Operations](./enterprise/active-active/crdb.md)
48+
- [CRDB Tasks](./enterprise/active-active/crdb-tasks.md)
49+
- [Monitoring]()
50+
- [Statistics](./enterprise/monitoring/stats.md)
51+
- [Logs](./enterprise/monitoring/logs.md)
52+
- [Alerts](./enterprise/monitoring/alerts.md)
53+
- [Usage Reports](./enterprise/monitoring/usage-report.md)
54+
- [Operations]()
55+
- [Support Package](./enterprise/operations/support-package.md)
56+
- [Debug Info](./enterprise/operations/debuginfo.md)
57+
- [Diagnostics](./enterprise/operations/diagnostics.md)
58+
- [License Management](./enterprise/operations/license.md)
59+
- [Migrations](./enterprise/operations/migration.md)
60+
- [Advanced]()
61+
- [Actions](./enterprise/advanced/actions.md)
62+
- [Workflows](./enterprise/advanced/workflows.md)
63+
- [Job Scheduler](./enterprise/advanced/job-scheduler.md)
64+
- [Bootstrap](./enterprise/advanced/bootstrap.md)
65+
- [Proxies](./enterprise/advanced/proxy.md)
66+
- [Endpoints](./enterprise/advanced/endpoints.md)
67+
- [Services](./enterprise/advanced/services.md)
68+
- [CM Settings](./enterprise/advanced/cm-settings.md)
69+
- [OCSP](./enterprise/advanced/ocsp.md)
70+
- [DNS Suffix](./enterprise/advanced/suffix.md)
71+
- [JSON Schema](./enterprise/advanced/jsonschema.md)
6172
- [Examples](./enterprise/examples.md)
73+
- [Human-Friendly Commands](./enterprise/human-commands.md)
74+
- [All Commands](./enterprise/commands.md)
75+
- [API Access](./enterprise/api-access.md)
6276

63-
# Core Features
77+
# Common Features
6478

65-
- [Async Operations](./features/async-operations.md)
66-
- [Output Formats](./features/output-formats.md)
67-
- [Profile Management](./features/profiles.md)
68-
- [Workflows](./features/workflows.md)
79+
- [Output Formats](./common-features/output-formats.md)
80+
- [JMESPath Queries](./common-features/jmespath-queries.md)
81+
- [Async Operations](./common-features/async-operations.md)
82+
- [Raw API Access](./common-features/raw-api.md)
83+
- [Secure Storage](./common-features/secure-storage.md)
6984

7085
# Tutorials
7186

87+
- [CI/CD Integration](./tutorials/cicd.md)
7288
- [Common Recipes](./tutorials/common-recipes.md)
73-
- [Managing Production Databases](./tutorials/production-databases.md)
74-
- [Setting Up Monitoring](./tutorials/monitoring.md)
7589
- [Disaster Recovery](./tutorials/disaster-recovery.md)
90+
- [Monitoring Setup](./tutorials/monitoring.md)
7691
- [Network Security](./tutorials/network-security.md)
77-
- [CI/CD Integration](./tutorials/cicd.md)
92+
- [Production Databases](./tutorials/production-databases.md)
7893

7994
# Reference
8095

8196
- [Environment Variables](./reference/environment-variables.md)
8297
- [Configuration File](./reference/config-file.md)
83-
- [Security Best Practices](./reference/security.md)
84-
- [Troubleshooting](./reference/troubleshooting.md)
98+
- [Security](./reference/security.md)
8599
- [Best Practices](./reference/best-practices.md)
86-
- [API Reference](./reference/api.md)
100+
- [Troubleshooting](./reference/troubleshooting.md)
101+
102+
# API Reference
103+
104+
- [API Overview](./api-reference/api.md)
87105

88-
# Developer Guide
106+
# Developer
89107

90108
- [Architecture](./developer/architecture.md)
91-
- [Using the Libraries](./developer/libraries.md)
92-
- [Contributing](./developer/contributing.md)
93-
- [Adding Commands](./developer/adding-commands.md)
109+
- [Libraries](./developer/libraries.md)
110+
- [Contributing](./developer/contributing.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)