Skip to content

Modernization Plan for redis-enterprise-observability #40

@joshrotenberg

Description

@joshrotenberg

This issue proposes a few high-level improvements to make the repository easier to use, easier to maintain, and ready for future growth.

  • Repository Structure Cleanup

    • Organize files under clear directories: docs/, platforms/, demos/, .github/.
    • Migrate the playbook into docs/. Separate demos from production assets.
  • CI/CD - Validation

    • Add a GitHub Action to validate JSON (dashboards) and YAML (rules).
    • Investigate more thorough platform specific validation options
  • CI/CD - Release Automation

    • Set up release-please for versioning and changelogs.
    • Package dashboards and rules into .zip artifacts (excluding demos).
    • Schedule weekly automated release.
  • Documentation Centralization

    • Move all docs into docs/, organize by platform, and prepare for possible MkDocs site generation.
    • Create a single source of documentation truth, either in the repo (MkDocs? adoc?) or on redis.io

Sub issues incoming for these with more details and task lists.

Sub-issues

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions