Skip to content

Commit c6d1e31

Browse files
docs: reorganize documentation structure for better navigation (#362)
* fix: resolve compilation warnings for secure-storage feature - Add conditional imports for anyhow::{anyhow, Context} only when secure-storage is enabled - Mark unused variables with _ when secure-storage is disabled - Conditionally compile SERVICE_NAME constant only when needed - Fix error handling in keyring operations * docs: add missing examples pages to SUMMARY.md - Add cloud/examples.md to Cloud section - Add enterprise/examples.md to Enterprise section - Fixes broken links in overview pages * 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 5934efb commit c6d1e31

Some content is hidden

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

60 files changed

+813
-1723
lines changed

crates/redisctl/src/credential_store.rs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@
66
//! - Plaintext storage (fallback)
77
//! - Environment variable override
88
9-
use anyhow::{Context, Result};
9+
use anyhow::Result;
10+
#[cfg(feature = "secure-storage")]
11+
use anyhow::{Context, anyhow};
1012
use std::env;
1113

1214
/// Prefix that indicates a value should be retrieved from the keyring
1315
const KEYRING_PREFIX: &str = "keyring:";
1416

1517
/// Service name for keyring entries
18+
#[cfg(feature = "secure-storage")]
1619
const SERVICE_NAME: &str = "redisctl";
1720

1821
/// Storage backend for credentials
@@ -97,6 +100,7 @@ impl CredentialStore {
97100
#[cfg(not(feature = "secure-storage"))]
98101
{
99102
// Without secure-storage feature, always use plaintext
103+
let _ = key; // Not used without secure-storage
100104
Ok(value.to_string())
101105
}
102106
}
@@ -150,14 +154,17 @@ impl CredentialStore {
150154
match entry.delete_credential() {
151155
Ok(()) => Ok(()),
152156
Err(keyring::Error::NoEntry) => Ok(()), // Already deleted
153-
Err(e) => Err(e).context("Failed to delete credential from keyring"),
157+
Err(e) => {
158+
Err(anyhow!(e)).context("Failed to delete credential from keyring")
159+
}
154160
}
155161
}
156162
CredentialStorage::Plaintext => Ok(()), // Nothing to delete for plaintext
157163
}
158164
}
159165
#[cfg(not(feature = "secure-storage"))]
160166
{
167+
let _ = key; // Not used without secure-storage
161168
Ok(()) // Nothing to delete for plaintext
162169
}
163170
}

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: 80 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,87 +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)
26-
27-
# Redis Enterprise Commands
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)
29+
- [Examples](./cloud/examples.md)
30+
- [Human-Friendly Commands](./cloud/human-commands.md)
31+
- [All Commands](./cloud/commands.md)
32+
33+
# Redis Enterprise
2834

2935
- [Overview](./enterprise/overview.md)
30-
- [Cluster](./enterprise/cluster.md)
31-
- [Bootstrap](./enterprise/bootstrap.md)
32-
- [CM Settings](./enterprise/cm-settings.md)
33-
- [Databases](./enterprise/databases.md)
34-
- [Database Groups](./enterprise/bdb-groups.md)
35-
- [Shards](./enterprise/shards.md)
36-
- [Nodes](./enterprise/nodes.md)
37-
- [Proxy Management](./enterprise/proxy.md)
38-
- [Users & RBAC](./enterprise/users.md)
39-
- [Statistics](./enterprise/stats.md)
40-
- [Usage Reports](./enterprise/usage-report.md)
41-
- [Modules](./enterprise/modules.md)
42-
- [Logs](./enterprise/logs.md)
43-
- [Database Migration](./enterprise/migration.md)
44-
- [Active-Active (CRDB)](./enterprise/crdb.md)
45-
- [CRDB Tasks](./enterprise/crdb-tasks.md)
46-
- [Actions (Tasks)](./enterprise/actions.md)
47-
- [Alerts](./enterprise/alerts.md)
48-
- [Debug Info](./enterprise/debuginfo.md)
49-
- [Diagnostics](./enterprise/diagnostics.md)
50-
- [Endpoints](./enterprise/endpoints.md)
51-
- [Job Scheduler](./enterprise/job-scheduler.md)
52-
- [JSON Schema](./enterprise/jsonschema.md)
53-
- [LDAP Integration](./enterprise/ldap.md)
54-
- [License Management](./enterprise/license.md)
55-
- [OCSP Validation](./enterprise/ocsp.md)
56-
- [Service Management](./enterprise/services.md)
57-
- [DNS Suffixes](./enterprise/suffix.md)
58-
- [Workflows](./enterprise/workflows.md)
59-
- [Raw API Access](./enterprise/api-access.md)
60-
61-
# Core Features
62-
63-
- [Async Operations](./features/async-operations.md)
64-
- [Output Formats](./features/output-formats.md)
65-
- [Profile Management](./features/profiles.md)
66-
- [Workflows](./features/workflows.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)
72+
- [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)
76+
77+
# Common Features
78+
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)
6784

6885
# Tutorials
6986

87+
- [CI/CD Integration](./tutorials/cicd.md)
7088
- [Common Recipes](./tutorials/common-recipes.md)
71-
- [Managing Production Databases](./tutorials/production-databases.md)
72-
- [Setting Up Monitoring](./tutorials/monitoring.md)
7389
- [Disaster Recovery](./tutorials/disaster-recovery.md)
90+
- [Monitoring Setup](./tutorials/monitoring.md)
7491
- [Network Security](./tutorials/network-security.md)
75-
- [CI/CD Integration](./tutorials/cicd.md)
92+
- [Production Databases](./tutorials/production-databases.md)
7693

7794
# Reference
7895

7996
- [Environment Variables](./reference/environment-variables.md)
8097
- [Configuration File](./reference/config-file.md)
81-
- [Security Best Practices](./reference/security.md)
82-
- [Troubleshooting](./reference/troubleshooting.md)
98+
- [Security](./reference/security.md)
8399
- [Best Practices](./reference/best-practices.md)
84-
- [API Reference](./reference/api.md)
100+
- [Troubleshooting](./reference/troubleshooting.md)
101+
102+
# API Reference
103+
104+
- [API Overview](./api-reference/api.md)
85105

86-
# Developer Guide
106+
# Developer
87107

88108
- [Architecture](./developer/architecture.md)
89-
- [Using the Libraries](./developer/libraries.md)
90-
- [Contributing](./developer/contributing.md)
91-
- [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.

0 commit comments

Comments
 (0)