search

open-telemetry / opentelemetry-sqlcommenter

SQLCommenter components for various languages
Apache License 2.0
27 stars 12 forks source link

Update Ruby docs with latest Rails support #35

Open modulitos opened 1 year ago

modulitos commented 1 year ago

This PR updates the Ruby docs to leverage the support Rails has recently provided for SQLCommenter. This will facilitate adoption of SQLCommenter for folks who aren't familiar with how SQLCommenter support has changed across Rails versions.

Note that the current docs are not compatible with Rails versions 6.0 and up. This PR makes the following changes to bring them up to date:

  1. For Rails >=7.1, include docs about how SQLCommenter is now fully supported as the default formatter
    • Support was added in this PR, and it will be the default formatter as well (added in this PR).
  2. For Rails 7.0, include docs on the PlanetScale SQLCommenter gem which is a workaround that provides SQLCommenter support for Rails 7.0
    • The Marginalia library was re-implemented natively in Rails version 7.0 (in this PR), so the current documentation that leverages a Marginalia fork will not work.
  3. Replace glebm's fork of Marginalia with modulitos's fork, which includes updates to support Rails 6.
linux-foundation-easycla[bot] commented 1 year ago

CLA Signed

The committers listed above are authorized under a signed CLA.