Skip to content

Repository Structure Cleanup #41

@joshrotenberg

Description

@joshrotenberg

Overview

This issue proposes restructuring the repository into a clearer layout to make navigation easier, support future automation, and separate production assets from demos.

Proposed Structure

redis-enterprise-observability/
├── README.md
├── LICENSE
├── CHANGELOG.md
├── docs/
│   ├── index.md
│   ├── getting-started.md
│   ├── platform-guides/
│   │   ├── grafana.md
│   │   ├── prometheus.md
│   │   ├── dynatrace.md
│   │   ├── newrelic.md
│   │   ├── kibana.md
│   │   └── splunk.md
│   └── playbook/
│       ├── images/
│       └── playbook.adoc
├── platforms/
│   ├── grafana/
│   │   ├── v1/
│   │   ├── v2/
│   ├── prometheus/
│   │   ├── v1/
│   │   ├── v2/
│   ├── dynatrace/
│   │   ├── v1/
│   │   ├── v2/
│   ├── newrelic/
│   │   ├── v1/
│   │   ├── v2/
│   ├── kibana/
│   ├── splunk/
│   └── README.md
├── demos/
│   ├── grafana-v1/
│   ├── grafana-v2/
│   └── README.md
├── .github/
│   ├── workflows/
│   │   ├── ci.yml
│   │   └── release.yml

Tasks

  • Create docs/ and migrate existing playbook content under docs/playbook/
  • Create platforms/ and move platform assets:
    • Move Grafana assets into platforms/grafana/
    • Move Prometheus assets into platforms/prometheus/
    • Move Dynatrace assets into platforms/dynatrace/
    • Move New Relic assets into platforms/newrelic/
    • Move Kibana assets into platforms/kibana/
    • Move Splunk assets into platforms/splunk/
  • Create demos/ and move all demo environments into appropriate subdirectories
  • Move GitHub Actions workflows into .github/workflows/
  • Add small README.md to:
    • docs/
    • platforms/
    • demos/
  • Validate links and references (demo scripts, playbook images, internal links)

Notes

  • No content changes (only file moves).
  • Keep v1/v2 splits under each platform.
  • Demos remain outside of packaged release content.

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