refactor: cleanup readme, bump docs dependencies (#2469)

1. Cleanup `README.md` - removed outdated destinations and updated the image + text contents 2. Updated deps in `/docs` to resolve 3 security reports: - https://github.com/odigos-io/odigos/security/dependabot/260 - https://github.com/odigos-io/odigos/security/dependabot/262 - https://github.com/odigos-io/odigos/security/dependabot/264
odigos-io · Feb 18, 2025 · 56b34aa · 56b34aa
1 parent 2159217
commit 56b34aa
Show file tree

Hide file tree

Showing 13 changed files with 374 additions and 186 deletions.
diff --git a/README.md b/README.md
@@ -1,56 +1,57 @@
 <p align="center">
     <a href="https://github.com/odigos-io/odigos/actions/workflows/release.yml" target="_blank">
-        <img src="https://github.com/odigos-io/odigos/actions/workflows/release.yml/badge.svg" alt="Release Odigos CLI" style="margin-right: 10px; border: 1px solid #007acc; border-radius: 4px; padding: 5px;">
+        <img src="https://github.com/odigos-io/odigos/actions/workflows/release.yml/badge.svg" alt="Release Odigos CLI"/>
     </a>
     <a href="https://goreportcard.com/report/github.com/odigos-io/odigos/cli" target="_blank">
-        <img src="https://goreportcard.com/badge/github.com/odigos-io/odigos/cli" alt="Go Report Card" style="margin-right: 10px; border: 1px solid #4CAF50; border-radius: 4px; padding: 5px;">
+        <img src="https://goreportcard.com/badge/github.com/odigos-io/odigos/cli" alt="Go Report Card"/>
     </a>
     <a href="https://godoc.org/github.com/odigos-io/odigos/cli" target="_blank">
-        <img src="https://godoc.org/github.com/odigos-io/odigos/cli?status.svg" alt="GoDoc" style="border: 1px solid #f39c12; border-radius: 4px; padding: 5px;">
+        <img src="https://godoc.org/github.com/odigos-io/odigos/cli?status.svg" alt="GoDoc"/>
     </a>
 </p>
 
-<p align="center">
-<img src="assets/logo.png" width="350" /></br>
-<h2>Generate distributed traces for any application in Kubernetes without code changes.</h2>
-If you find Odigos helpful, please ⭐ this repository to show your support!
-</p>
+[![Logo Dark Mode](./docs/logo/logo_white.svg)](https://odigos.io#gh-dark-mode-only)
+[![Logo Light Mode](./docs/logo/logo_black.svg)](https://odigos.io#gh-light-mode-only)
 
-<h2 align="center">
-    <a href="https://www.youtube.com/watch?v=nynyV7FC4VI">Demo Video</a> • <a href="https://docs.odigos.io">Documentation</a> • <a href="https://join.slack.com/t/odigos/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A">Join Slack Community</a>
-</h2>
+<div align="center">
+    <h2>Generate distributed traces for any application without code changes.</h2>
+    <h4>If you find Odigos helpful, please ⭐ this repository to show your support!</h4>
+    <h2>
+        <a href="https://www.youtube.com/watch?v=nynyV7FC4VI">Demo Video</a>
+        • <a href="https://docs.odigos.io">Documentation</a>
+        • <a href="https://join.slack.com/t/odigos/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A">Join Slack Community</a>
+    </h2>
+</div>
 
 ## What is Odigos?
 
-Odigos is an open-source distributed tracing solution that simplifies and improves observability for Kubernetes environments. It provides instant tracing capabilities without requiring any code changes to your applications.
-
-## Key Features
+Odigos is an open-source distributed tracing solution that simplifies and improves observability for Kubernetes environments and Virtual Machines. It provides instant tracing capabilities without requiring any code changes to your applications.
 
-- **Code-Free Instrumentation** : Set up distributed tracing in minutes, eliminating manual code modifications.
-- **Multi-Language Support** : Works with Java, Python, .NET, Node.js, and Go applications.
-- **eBPF-Powered** : Utilizes eBPF technology for high-performance instrumentation of Go applications. eBPF-based instrumentation for Java, Python, and Node.js is available in the enterprise edition.
-- **OpenTelemetry Compatible** : Generates traces in OpenTelemetry format for broad tool compatibility.
-- **Vendor Agnostic** : Integrates with various monitoring solutions, avoiding vendor lock-in.
-- **Automatic Scaling** : Manages and scales OpenTelemetry collectors based on data volume.
-- **Opinionated Defaults** : Supplies common defaults and best practices out-of-the-box, requiring no deep knowledge of OpenTelemetry.
+Odigos empowers platform engineers, DevOps professionals, and SREs to enhance their observability strategies quickly and effectively. It is an ideal solution for modern cloud-native environments, combining simplicity, performance, and industry expertise.
 
-## Why Choose Odigos
+## Why choose Odigos?
 
 1. **Simplicity** : Implement distributed tracing with minimal effort and complexity.
 2. **Performance** : Separates data recording and processing to minimize runtime impact.
 3. **Community-Backed** : With 3,000+ GitHub stars and a growing contributor base.
 4. **Expertise** : Created by multiple maintainers of OpenTelemetry, ensuring deep integration and alignment with industry standards.
 
-Odigos empowers platform engineers, DevOps professionals, and SREs to enhance their observability strategies quickly and effectively. It is an ideal solution for modern cloud-native environments, combining simplicity, performance, and industry expertise.
+## Key Features
 
-## Features
+- **Code-Free Instrumentation** : Set up distributed tracing in minutes, eliminating manual code modifications.
+- **Multi-Language Support** : Works with [Java](https://docs.odigos.io/instrumentations/java), [Python](https://docs.odigos.io/instrumentations/python), [.NET](https://docs.odigos.io/instrumentations/dotnet), [Node.js](https://docs.odigos.io/instrumentations/nodejs), and [Go](https://docs.odigos.io/instrumentations/golang) applications.
+- **eBPF-Powered** : Utilizes eBPF technology for high-performance instrumentation.
+- **OpenTelemetry Compatible** : Generates traces in OpenTelemetry format for broad tool compatibility.
+- **Vendor Agnostic** : Integrates with various [monitoring solutions](https://docs.odigos.io/backends-overview), avoiding vendor lock-in.
+- **Automatic Scaling** : Manages and scales OpenTelemetry collectors based on data volume.
+- **Opinionated Defaults** : Supplies common defaults and best practices out-of-the-box, requiring no deep knowledge of OpenTelemetry.
 
 ### ✨ Language Agnostic Auto-instrumentation
 
 Odigos supports any application written in Java, Python, .NET, Node.js, and **Go**.
 Historically, compiled languages like Go have been difficult to instrument without code changes. Odigos solves this problem by uniquely leveraging [eBPF](https://ebpf.io).
 
-![Works on any application](docs/images/ui_choose_apps.png)
+![Works on any application](./docs/images/ui_choose_apps.png)
 
 ### 🤝 Keep your existing observability tools
 
@@ -59,87 +60,31 @@ By producing data in the [OpenTelemetry](https://opentelemetry.io) format, Odigo
 
 For a complete list of supported destinations, see [here](#supported-destinations).
 
-![Works with any observability tool](docs/images/ui_choose_dest.png)
+![Works with any observability tool](./docs/images/ui_choose_dest.png)
 
 ### 🎛️ Collectors Management
 
 Odigos automatically scales OpenTelemetry collectors based on observability data volume.
 Manage and configure collectors via a convenient web UI.
 
-![Collectors Management](docs/images/ui_overview.png)
+![Collectors Management](./docs/images/ui_overview.png)
 
 ## Installation
 
-Installing Odigos takes less than 5 minutes and requires no code changes.
+Installing Odigos takes less than 5 minutes and requires no code changes.<br />
 Download our [CLI](https://docs.odigos.io/installation) and run the following command:
 
 ```bash
 odigos install
 ```
 
-For more details, see our [quickstart guide](https://docs.odigos.io/intro).
-
-## Supported Destinations
-
-**For step-by-step instructions detailed for every destination, see these [docs](https://docs.odigos.io/backends).**
-
-### Managed Destinations
-
-| Destination             | Traces | Metrics | Logs |
-| ----------------------- | :----: | :-----: | :--: |
-| AppDynamics             |   ✅   |   ✅    |  ✅  |
-| Axiom                   |   ✅   |         |  ✅  |
-| AWS S3                  |   ✅   |         |  ✅  |
-| Azure Blob Storage      |   ✅   |         |  ✅  |
-| Better Stack            |        |   ✅    |  ✅  |
-| Causely                 |   ✅   |         |      |
-| Chronosphere            |   ✅   |   ✅    |      |
-| Coralogix               |   ✅   |   ✅    |  ✅  |
-| Dash0                   |   ✅   |   ✅    |  ✅  |
-| Datadog                 |   ✅   |   ✅    |  ✅  |
-| Dynatrace               |   ✅   |   ✅    |  ✅  |
-| Gigapipe                |   ✅   |   ✅    |  ✅  |
-| Google Cloud Monitoring |   ✅   |   ✅    |      |
-| Google Cloud Storage    |   ✅   |         |  ✅  |
-| Grafana Cloud           |   ✅   |   ✅    |  ✅  |
-| Groundcover inCloud     |   ✅   |   ✅    |  ✅  |
-| Honeycomb               |   ✅   |   ✅    |  ✅  |
-| HyperDX                 |   ✅   |   ✅    |  ✅  |
-| KloudMate               |   ✅   |   ✅    |  ✅  |
-| Last9                   |   ✅   |   ✅    |      |
-| Lightstep               |   ✅   |         |      |
-| Logz.io                 |   ✅   |   ✅    |  ✅  |
-| Lumigo                  |   ✅   |   ✅    |  ✅  |
-| New Relic               |   ✅   |   ✅    |  ✅  |
-| OpsVerse                |   ✅   |   ✅    |  ✅  |
-| Sentry                  |   ✅   |         |      |
-| Splunk                  |   ✅   |         |      |
-| Sumo Logic              |   ✅   |   ✅    |  ✅  |
-| Traceloop               |   ✅   |   ✅    |      |
-
-## Self-Hosted (Open Source) Destinations
-
-| Destination   | Traces | Metrics | Logs |
-| ------------- | :----: | :-----: | :--: |
-| ClickHouse    |   ✅   |   ✅    |  ✅  |
-| Elasticsearch |   ✅   |         |  ✅  |
-| Jaeger        |   ✅   |         |      |
-| Loki          |        |         |  ✅  |
-| OTLP          |   ✅   |   ✅    |  ✅  |
-| OTLP HTTP     |   ✅   |   ✅    |  ✅  |
-| Prometheus    |        |   ✅    |      |
-| Quickwit      |   ✅   |         |      |
-| qryn          |   ✅   |   ✅    |  ✅  |
-| SigNoz        |   ✅   |   ✅    |  ✅  |
-| Tempo         |   ✅   |         |      |
-
-Can't find the destination you need? Help us by following our quick [add new destination](https://docs.odigos.io/adding-new-dest) guide and submitting a PR.
+For more information, see our [quickstart guide](https://docs.odigos.io/quickstart/introduction).
 
 ## Contributing
 
-Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information about how to get involved. We welcome issues, questions, and pull requests. Feel free to join our active [Slack Community](https://join.slack.com/t/odigos/shared_invite/zt-1d7egaz29-Rwv2T8kyzc3mWP8qKobz~A).
+Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information about how to get involved. We welcome issues, questions, and pull requests.
 
-## All Thanks To Our Contributors
+## Thanks to our Contributors
 
 <a href="https://github.com/odigos-io/odigos/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=keyval-dev/odigos" />

diff --git a/assets/logo.png → docs/images/odigos_banner.png b/assets/logo.png → docs/images/odigos_banner.png
diff --git a/docs/images/ui_choose_apps.png b/docs/images/ui_choose_apps.png
diff --git a/docs/images/ui_choose_dest.png b/docs/images/ui_choose_dest.png
diff --git a/docs/images/ui_jaeger_connection.png b/docs/images/ui_jaeger_connection.png
diff --git a/docs/images/ui_overview.png b/docs/images/ui_overview.png
diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg