This directory contains documentation for the OpenTelemetry Ecosystem Explorer project. It includes guides, references, and resources to help users understand and contribute to the project.
Also reference the project wiki for additional information.
New contributors: Start with CONTRIBUTING.md for quick setup.
Understanding the system:
- Architecture Overview - Three-component system design and data flow
- Watchers and Registry Consumers - Automation pipeline
- Registry Structure - Metadata organization and versioning
- Content-Addressed Storage - Storage pattern for multi-version support
- Frontend Architecture - Web app caching and data loading
Deployment: The web app deploys automatically to production when changes merge to main. Registry updates run
nightly via GitHub Actions.
- Leverage automation as much as possible
- Reduce burden/overhead on maintainers as much as possible
- Keep maintenance burden and operational overhead of the web application low
- Avoid backend servers/databases and use static hosting/CDN where possible
- Prioritize responsiveness, accessibility and localization from the start