newrelic-ruby-agent icon indicating copy to clipboard operation
newrelic-ruby-agent copied to clipboard

Docs for supported databases / datastores are potentially confusing

Open fallwith opened this issue 1 year ago • 1 comments

The supported frameworks documentation might be confusing for people interested in knowing about compatibility with datastores for the following reasons:

  • The "instance details" section still lists ActiveRecord 2/3/4 as supported, which is incorrect
  • The existence of separate "databases" and "instance details" sections to outline datastore compatibility is confusing
  • The "instance details" section has a "gem databases" table which is confusing. The term "gem databases" is incorrect. Perhaps there was once an intention to list individual gems used for datastore client usage. The NoSQL stores Mongo and Redis are listed both in this table and in the one in the "databases" section. Given that there is only a single supported gem for each of these datastores, moving the info into the "databases" section would make the most sense.

https://docs.newrelic.com/docs/apm/agents/ruby-agent/getting-started/ruby-agent-requirements-supported-frameworks/

fallwith avatar Oct 12 '24 01:10 fallwith

https://new-relic.atlassian.net/browse/NR-325364

Instance details was updated with: https://github.com/newrelic/docs-website/pull/19444#event-15540735339

We should still consider bullet points 2 and 3 in the description.

hannahramadan avatar Dec 19 '24 17:12 hannahramadan

Relates to #2832

kaylareopelle avatar Mar 04 '25 21:03 kaylareopelle