Skip to content
This repository was archived by the owner on May 29, 2026. It is now read-only.

Ruby on Rails documentation updates#169

Merged
sjs994 merged 1 commit into
google:masterfrom
modulitos:update-ruby-docs
Dec 8, 2022
Merged

Ruby on Rails documentation updates#169
sjs994 merged 1 commit into
google:masterfrom
modulitos:update-ruby-docs

Conversation

@modulitos

Copy link
Copy Markdown
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
Copy Markdown
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

sjs994 commented Dec 8, 2022

Copy link
Copy Markdown
Contributor

Extremely sorry @modulitos. Somehow missed this PR.

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

@sjs994 sjs994 left a comment

Copy link
Copy Markdown
Contributor

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants