valid-categories.yml

page-valid-categories:
  - category: 'rpk'
    definition: 'Command-line tool for Redpanda administration and management. Includes topics related to configuring and using the rpk tool.'
  - category: 'Development'
    definition: 'Building, testing, and maintaining applications and services that use Redpanda.'
    subcategories:
      - category: 'Clients'
        definition: 'Using various client libraries to interact with Redpanda in different programming languages.'
      - category: 'Stream Processing'
        definition: 'Processing streaming data using Redpanda, including transformations, aggregations, and stateful processing.'
        related: ['flink']
      - category: 'Data Transforms'
        definition: 'Processing streaming data using Redpanda, including transformations, aggregations, and stateful processing.'
        related: ['wasm']
      - category: 'Benchmarking'
        definition: 'Measuring and evaluating the performance of Redpanda under various conditions and workloads. Benchmarking covers performance testing, throughput, and latency measurement, and optimizing configurations for maximum efficiency.'
  - category: 'Deployment'
    definition: 'Deploying Redpanda in various environments such as Docker, Kubernetes, or Redpanda Cloud.'
    subcategories:
      - category: 'Integration'
        definition: 'Integrating Redpanda with other systems and platforms, such as databases, message queues, or cloud services.'
      - category: 'Architecture'
        definition: 'Designing deployment architectures such as event-driven patterns and inter-service communication.'
      - category: 'GitOps'
        definition: 'Managing and automating the deployment and operation of software applications using Git as the source of truth. This category includes examples and best practices for deploying and managing Redpanda clusters and configurations using GitOps tools and methodologies.'
  - category: 'Management'
    definition: 'Performing operational tasks such as scaling, upgrades, and backups.'
    related: ['day2ops']
    subcategories:
      - category: 'Security'
        definition: 'Implementing security features such as SSL/TLS encryption, SASL authentication, and ACLs with Redpanda.'
      - category: 'Networking'
        definition: 'Configuring and managing network settings, protocols, and performance optimization for Redpanda. This includes internal communication between brokers, client connectivity, and integration with external systems.'
      - category: 'Monitoring'
        definition: 'Observing and analyzing operational metrics and logs. This category covers the tools, techniques, and best practices for effectively tracking the health, performance, and reliability of Redpanda clusters.'
        related: ['grafana', 'prometheus']
      - category: 'Scaling'
        definition: 'Strategies and best practices for scaling Redpanda clusters to handle increased workloads.'
  - category: 'Upgrades'
    definition: 'Upgrading Redpanda software and systems.'
    subcategories:
      - category: 'Migration'
        definition: 'Migrating from older versions of Redpanda.'
      - category: 'Rollback'
        definition: 'Procedures for rolling back Redpanda upgrades in case of issues.'
  - category: 'Kafka Compatibility'
    definition: 'Highlighting Kafka API compatibility in Redpanda, showing how existing Kafka applications can work with Redpanda.'
    subcategories:
      - category: 'Kafka Migration'
        definition: 'Migrating from Kafka to Redpanda.'
      - category: 'Feature Comparison'
        definition: 'Comparing features and capabilities between Kafka and Redpanda.'
  - category: 'Troubleshooting'
    definition: 'Troubleshooting common issues and errors encountered while working with Redpanda.'
  - category: 'Redpanda Console'
    definition: 'Covers the use, configuration, and features of the Redpanda Console, a web-based UI for managing and monitoring Redpanda clusters. This includes dashboard customization, security settings, user management, and integration with other services.'
  - category: 'High Availability'
    definition: 'Exploring strategies, configurations, and practices for achieving high availability in Redpanda deployments. This includes redundancy, failover mechanisms, replication, and other techniques to ensure continuous operation and data durability.'
    subcategories:
      - category: 'Data Replication'
        definition: 'Mechanisms and strategies for data replication across nodes and clusters, ensuring data integrity and availability even in the event of hardware or network issues.'
      - category: 'Failover and Recovery'
        definition: 'Procedures and tools for automatic failover and recovery in case of outages, including how to minimize downtime and data loss.'
      - category: 'Disaster Recovery'
        definition: 'Planning and implementing disaster recovery strategies, including backup and restore practices, to recover from significant system-wide failures.'
  - category: 'Schema Registry'
    definition: 'Covers the setup, configuration, and usage of the Schema Registry with Redpanda to manage schema versions, compatibility, and serialization formats.'