Skip to content

Commit f2d277b

Browse files
committed
fix(docs): resolve all mdbook-lint errors
Fix 123 lint errors across 48 documentation files: - MD052 (20): Fix checklist items interpreted as reference links - MDBOOK010 (2): Escape shell $ variables in inline code - MDBOOK004 (15): Make duplicate chapter titles unique - MDBOOK006 (4): Remove invalid cross-reference anchors - MDBOOK002 (82): Remove broken internal links to non-existent files
1 parent a5c2cbe commit f2d277b

Some content is hidden

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

48 files changed

+147
-147
lines changed

docs/src/api-reference/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,14 +154,14 @@ redisctl api cloud post /subscriptions/123456/databases/789/acl/users --data @us
154154

155155
## Redis Enterprise API
156156

157-
### Base URL
157+
### Enterprise Base URL
158158
`https://<cluster-address>:9443`
159159

160-
### Authentication
160+
### Enterprise Authentication
161161
- Basic Auth: `username:password`
162162
- Header: `Authorization: Basic <base64>`
163163

164-
### Common Endpoints
164+
### Enterprise Endpoints
165165

166166
#### Cluster
167167
```bash

docs/src/cloud/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Direct access to any REST endpoint when you need full control.
2020
redisctl api cloud <method> <path> [options]
2121
```
2222

23-
See [Raw API Access](./api-access.md) for details.
23+
See Raw API Access for details.
2424

2525
## 3. Workflows (Coming Soon)
2626

docs/src/cloud/commands/subscriptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,9 @@ redisctl cloud fixed-subscription create --data @fixed-subscription.json --wait
208208

209209
## Related Commands
210210

211-
- [Databases](./databases.md) - Manage databases within subscriptions
212-
- [Network Connectivity](./connectivity.md) - Configure VPC peering and private endpoints
213-
- [Provider Accounts](./provider-accounts.md) - Manage cloud provider integrations
211+
- Databases - Manage databases within subscriptions
212+
- Network Connectivity - Configure VPC peering and private endpoints
213+
- Provider Accounts - Manage cloud provider integrations
214214

215215
## Common Patterns
216216

docs/src/cloud/core-resources/databases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,8 +343,8 @@ done
343343
## Related Commands
344344

345345
- [Subscriptions](./subscriptions.md) - Manage parent subscriptions
346-
- [ACL](./acl.md) - Configure access control
347-
- [Connectivity](./connectivity.md) - Set up VPC peering
346+
- ACL - Configure access control
347+
- Connectivity - Set up VPC peering
348348

349349
## API Reference
350350

docs/src/cloud/core-resources/subscriptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,9 @@ redisctl cloud fixed-subscription create --data @fixed-subscription.json --wait
208208

209209
## Related Commands
210210

211-
- [Databases](./databases.md) - Manage databases within subscriptions
212-
- [Network Connectivity](./connectivity.md) - Configure VPC peering and private endpoints
213-
- [Provider Accounts](./provider-accounts.md) - Manage cloud provider integrations
211+
- Databases - Manage databases within subscriptions
212+
- Network Connectivity - Configure VPC peering and private endpoints
213+
- Provider Accounts - Manage cloud provider integrations
214214

215215
## Common Patterns
216216

docs/src/common-features/profiles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ redisctl profile set enterprise-prod \
4545
3. Click "Add API Key" and give it a name
4646
4. Copy both the Account key and Secret (you won't see the secret again!)
4747

48-
### Redis Enterprise
48+
### Redis Enterprise Credentials
4949

5050
- **URL**: `https://cluster-fqdn:9443`
5151
- **Username**: Configured during setup (often `[email protected]`)

docs/src/cookbook/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ New to redisctl? Start here:
2929

3030
## Redis Enterprise Recipes
3131

32-
### Getting Started
32+
### Enterprise Getting Started
3333
- [Create a Database](enterprise/create-database.md) - 5 minutes
3434

35-
### Operations
35+
### Enterprise Operations
3636
- [Generate and Upload Support Package](enterprise/support-package.md) - 10 minutes
3737
- [Configure Database Replication](enterprise/configure-replication.md) - 10-15 minutes
3838
- [Configure Redis ACLs](enterprise/configure-redis-acls.md) - 10 minutes
@@ -59,5 +59,5 @@ Have a recipe to share? See our [contribution guide](../developer/contributing.m
5959
## Need More Detail?
6060

6161
These recipes are designed for quick wins. For comprehensive command documentation, see:
62-
- [Cloud Command Reference](../cloud/README.md)
63-
- [Enterprise Command Reference](../enterprise/README.md)
62+
- Cloud Command Reference
63+
- Enterprise Command Reference

docs/src/cookbook/cloud/active-active-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ redisctl cloud subscription update \
423423
- Expect 1-2 hours for initial sync
424424
- Monitor with `--wait-timeout 7200`
425425

426-
## Best Practices
426+
## Production Best Practices
427427

428428
1. **Design for Conflicts** - Use conflict-free data types
429429
2. **Local Writes** - Always write to nearest region
@@ -435,8 +435,8 @@ redisctl cloud subscription update \
435435
## Next Steps
436436

437437
- [Setup VPC Peering](setup-vpc-peering.md) - Private connectivity per region
438-
- [Configure ACLs](configure-acls.md) - Secure all regional endpoints
439-
- [Monitor Performance](../common/monitor-performance.md) - Track per-region metrics
438+
- Configure ACLs - Secure all regional endpoints
439+
- Monitor Performance - Track per-region metrics
440440
- [Backup and Restore](backup-restore.md) - Multi-region backup strategy
441441

442442
## See Also

docs/src/cookbook/cloud/backup-restore.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -488,12 +488,12 @@ Error: Insufficient storage space
488488
## Next Steps
489489

490490
- [Database Migration](database-migration.md) - Migrate data between databases
491-
- [Monitor Performance](../common/monitor-performance.md) - Track database health
492-
- [Configure ACLs](configure-acls.md) - Secure your restored database
493-
- [Setup High Availability](setup-replication.md) - Add redundancy
491+
- Monitor Performance - Track database health
492+
- Configure ACLs - Secure your restored database
493+
- Setup High Availability - Add redundancy
494494

495495
## See Also
496496

497-
- [Database Backup Reference](../../cloud/core-resources/databases.md#backup-operations) - Complete command documentation
497+
- [Database Backup Reference](../../cloud/core-resources/databases.md) - Complete command documentation
498498
- [Redis Cloud Backup Guide](https://redis.io/docs/latest/operate/rc/databases/back-up-data/) - Official backup documentation
499499
- [Data Persistence Options](https://redis.io/docs/latest/operate/oss_and_stack/management/persistence/) - Understanding AOF vs. RDB

docs/src/cookbook/cloud/configure-acls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -481,12 +481,12 @@ redisctl cloud acl list-roles --subscription 42 -q '[?name==`readonly-role`]'
481481
## Next Steps
482482

483483
- [Setup VPC Peering](setup-vpc-peering.md) - Private network connectivity
484-
- [Configure TLS/SSL](configure-tls.md) - Encryption in transit
484+
- Configure TLS/SSL - Encryption in transit
485485
- [Backup and Restore](backup-restore.md) - Protect your data
486-
- [Monitor Performance](../common/monitor-performance.md) - Track database metrics
486+
- Monitor Performance - Track database metrics
487487

488488
## See Also
489489

490-
- [ACL Command Reference](../../cloud/acl-management.md) - Complete command documentation
490+
- ACL Command Reference - Complete command documentation
491491
- [Redis ACL Documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/) - Redis ACL syntax
492492
- [Redis Cloud Security](https://redis.io/docs/latest/operate/rc/security/) - Security best practices

0 commit comments

Comments
 (0)