Skip to content

Commit

Permalink
docs: Add opentelemetry.io docs (#691)
Browse files Browse the repository at this point in the history
* add website docs

* Update website_docs/_index.md

Co-authored-by: shelby spees <shelbyspees@users.noreply.github.com>

Co-authored-by: Francis Bogsanyi <francis.bogsanyi@shopify.com>
Co-authored-by: shelby spees <shelbyspees@users.noreply.github.com>
3 people authored Apr 30, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 33edd58 commit ef7cfd8
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions website_docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Ruby"
weight: 24
description: >
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
A language-specific implementation of OpenTelemetry in Ruby.
---

This is the OpenTelemetry for Ruby documentation. OpenTelemetry is an
observability framework -- an API, SDK, and tools that are designed to aid in
the generation and collection of application telemetry data such as metrics,
logs, and traces. This documentation is designed to help you understand how to
get started using OpenTelemetry for Ruby.

## Status and Releases

The current status of the major functional components for OpenTelemetry Ruby is
as follows:

| Tracing | Metrics | Logging |
| ------- | ------- | ------- |
| Beta | Not Yet Implemented | Not Yet Implemented |

The current release can be found [here](https://github.com/open-telemetry/opentelemetry-ruby/releases)

## Further Reading

- [OpenTelemetry for Ruby on GitHub](https://github.com/open-telemetry/opentelemetry-ruby)
- [Installation](https://github.com/open-telemetry/opentelemetry-ruby#installation)
- [Quick Start](https://github.com/open-telemetry/opentelemetry-ruby#quick-start)
- [API Documentation](https://open-telemetry.github.io/opentelemetry-ruby/)
- [Examples](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples)

0 comments on commit ef7cfd8

Please sign in to comment.