Skip to content

Repository Structure Cleanup #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
15 tasks
joshrotenberg opened this issue Apr 28, 2025 · 0 comments
Open
15 tasks

Repository Structure Cleanup #41

joshrotenberg opened this issue Apr 28, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@joshrotenberg
Copy link

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.
@joshrotenberg joshrotenberg added the enhancement New feature or request label Apr 28, 2025
@joshrotenberg joshrotenberg self-assigned this Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant