Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ruby on Rails documentation updates #169

Merged
merged 1 commit into from
Dec 8, 2022

Conversation

modulitos
Copy link
Contributor

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 7.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.

Corresponding PR in the OpenTelemetry repo: open-telemetry/opentelemetry-sqlcommenter#35

@modulitos
Copy link
Contributor Author

Kindly pinging @sjs994 - is there anything I can do to help get this PR reviewed?

@sjs994 sjs994 requested a review from kapv89 December 8, 2022 09:56
@sjs994
Copy link
Collaborator

sjs994 commented Dec 8, 2022

Extremely sorry @modulitos. Somehow missed this PR.

Have added a reviewer to take a look at this PT.

Copy link
Collaborator

@sjs994 sjs994 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sjs994 sjs994 merged commit 36ce7d3 into google:master Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants