Skip to content

Docs Phase 2: Command Documentation #245

@joshrotenberg

Description

@joshrotenberg

Part of #243

Goal

Create comprehensive, well-organized command documentation for both Cloud and Enterprise.

Tasks

  • Create one page per command group
  • Document Redis Cloud commands:
    • Subscriptions (list, get, create, update, delete)
    • Databases (list, get, create, update, delete, backup/import/export)
    • Network (VPC Peering, PSC, Transit Gateway)
    • Access Control (ACL rules, roles, users)
    • Account Management
  • Document Redis Enterprise commands:
    • Cluster (info, update, policy, certificates)
    • Databases/BDB (list, get, create, update, delete)
    • Nodes (list, get, update, actions)
    • RBAC (users, roles, LDAP)
    • Statistics (cluster, database, node, shard)
    • Modules (list, upload, configure, delete)
    • Logs (list, filter, export)
  • For each command include:
    • Command syntax
    • All flags/options
    • Real-world examples
    • Common patterns
    • Related commands

Success Criteria

  • Every command is documented with examples
  • Users can find any command reference within 2 clicks
  • Examples are tested and working

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions