From cb44f71a9e9b555caf2c70b996cd078c3ca67097 Mon Sep 17 00:00:00 2001 From: Ariel Valentin Date: Wed, 13 Oct 2021 15:16:22 -0500 Subject: [PATCH] docs: Stable Release Updates (#968) - Moved "who's using" section to the website docs to increase visibility - Added table of contents on the repo homepage See https://github.com/open-telemetry/opentelemetry-ruby/issues/775 --- README.md | 88 +++++------------------------------------- website_docs/_index.md | 15 ++++++- 2 files changed, 24 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 415d502e2..44912c3ee 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,13 @@ The Ruby [OpenTelemetry](https://opentelemetry.io/) client. +- [Getting Started][getting-started] +- [Contributing](#contributing) +- [Instrumentation Libraries](#instrumentation-libraries) +- [Versioning](#versioning) +- [Useful links](#useful-links) +- [License](#license) + ## Contributing We'd love your help! Use tags [good first issue][issues-good-first-issue] and @@ -35,70 +42,6 @@ Maintainers ([@open-telemetry/ruby-maintainers](https://github.com/orgs/open-tel *Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).* -## Installation - -This repository includes multiple installable packages. The `opentelemetry-api` -package includes abstract classes and no-op implementations that comprise the OpenTelemetry API following -[the -specification](https://github.com/open-telemetry/opentelemetry-specification). -The `opentelemetry-sdk` package is the reference implementation of the API. - -Libraries that produce telemetry data should only depend on `opentelemetry-api`, -and defer the choice of the SDK to the application developer. Applications may -depend on `opentelemetry-sdk` or another package that implements the API. - -**Please note** that this library is currently in _beta_ for tracing. - -The API and SDK packages are available on RubyGems.org, and can be installed via `gem`: - -```sh -gem install opentelemetry-api -gem install opentelemetry-sdk -``` - -or via `Bundler` by adding the following to your `Gemfile`: - -```ruby -gem 'opentelemetry-api' -gem 'opentelemetry-sdk' -``` -followed by: -```sh -bundle install -``` - -To install development versions of these packages, follow the [Docker Setup instructions](CONTRIBUTING.md#docker-setup). - -## Quick Start - -```ruby -require 'opentelemetry/sdk' - -# Configure the sdk with default export and context propagation formats -# see SDK#configure for customizing the setup -OpenTelemetry::SDK.configure - -# To start a trace you need to get a Tracer from the TracerProvider -tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0') - -# create a span -tracer.in_span('foo') do |span| - # set an attribute - span.set_attribute('platform', 'osx') - # add an event - span.add_event('event in bar') - # create bar as child of foo - tracer.in_span('bar') do |child_span| - # inspect the span - pp child_span - end -end -``` - -See the [API Documentation](https://open-telemetry.github.io/opentelemetry-ruby/) for more -detail, and the [opentelemetry examples][examples-github] for a complete example including -context propagation. - ## Instrumentation Libraries This repository contains instrumentation libraries for many popular Ruby @@ -108,20 +51,7 @@ using OpenTelemetry with minimal changes to your application. See the ## Versioning -OpenTelemetry Ruby follows the [versioning and stability document](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) in the OpenTelemetry specification. Notably, we adhere to the outlined version numbering exception, which states that experimental signals may have a `0.x` version number. - -## Who's using OpenTelemetry Ruby? - -OpenTelemetry Ruby is in use by a number of companies, including: - -- [Heroku](https://heroku.com) -- [GitHub](https://github.com/) -- [Fulcrum](https://www.fulcrumapp.com/) -- [Puppet](https://puppet.com/) -- [Shopify](https://shopify.com) -- [TableCheck](https://www.tablecheck.com/) - -If you would like to add your name to this list, please feel free to submit a pull request. +OpenTelemetry Ruby follows the [versioning and stability document][otel-versioning] in the OpenTelemetry specification. Notably, we adhere to the outlined version numbering exception, which states that experimental signals may have a `0.x` version number. ## Useful links @@ -134,6 +64,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [ci-image]: https://github.com/open-telemetry/opentelemetry-ruby/workflows/CI/badge.svg?event=push [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples +[getting-started]: https://opentelemetry.io/docs/ruby/ [issues-good-first-issue]: https://github.com/open-telemetry/opentelemetry-ruby/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 [issues-help-wanted]: https://github.com/open-telemetry/opentelemetry-ruby/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat @@ -143,3 +74,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [slack-image]: https://img.shields.io/badge/slack-@cncf/otel/ruby-brightgreen.svg?logo=slack [slack-url]: https://cloud-native.slack.com/archives/C01NWKKMKMY [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions +[otel-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md diff --git a/website_docs/_index.md b/website_docs/_index.md index c7af1b02f..73476d8bf 100644 --- a/website_docs/_index.md +++ b/website_docs/_index.md @@ -21,10 +21,23 @@ as follows: | Tracing | Metrics | Logging | | ------- | ------- | ------- | -| Release Candidate | Not Yet Implemented | Not Yet Implemented | +| Stable | Not Yet Implemented | Not Yet Implemented | The current release can be found [here][releases] +## Who's using OpenTelemetry Ruby? + +OpenTelemetry Ruby is in use by a number of companies, including: + +- [Heroku](https://heroku.com) +- [GitHub](https://github.com/) +- [Fulcrum](https://www.fulcrumapp.com/) +- [Puppet](https://puppet.com/) +- [Shopify](https://shopify.com) +- [TableCheck](https://www.tablecheck.com/) + +If you would like to add your name to this list, please feel free to submit a pull request. + ## Further Reading - [OpenTelemetry for Ruby on GitHub][repository]