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

Update documentation examples for Rails 7.0 Support

Open kaylareopelle opened this issue 3 years ago • 2 comments

Feature Description

It can be frustrating to find documentation that suits your use case, but end up with an example that continues to raise errors.

Let's take some time to verify the examples in the Ruby Agent's documentation work on Rails 7.0. All examples should be technically accurate and functional for Rails 7.0 to complete this story. If code changes will take time that exceeds the estimate, reach out to the team to separate changes out into additional issues.

Documentation to Verify

Additional context

Currently, there is a disclaimer listed at the top of articles with examples that have not been tested with Rails 7.0. This should be removed once examples are tested and, if necessary, updated.

kaylareopelle avatar Jan 20 '22 02:01 kaylareopelle

Team discussion notes

Size: Small

  • Technical accuracy in this story
  • Wordsmithing can occur in other stories
  • Important to have this done so that we can be clear about what's supported in Rails 7
  • If things aren't working in Rails 7 and the time exceeds the estimate, it can go into a different ticket
  • May be able to wrap examples in the #executor blocks to resolve issues if they arise

Priority: High - important to have a published source of truth about custom instrumentation for our most popular framework Helping support, ourselves, and our customers be their best advocates by having access to accurate information

kaylareopelle avatar Jan 24 '22 22:01 kaylareopelle

https://issues.newrelic.com/browse/NEWRELIC-3389

@hannahramadan

  • Look at similar documentation
  • Review current documentation
  • Make a plan for what needs to change
  • Look at Rails guides and see if adapt our documentation to be more compatible with Rails guides (ex: when we talk about using initializers in our documentation, do our steps make sense based on how things are discussed in the corresponding Rails guide)

kaylareopelle avatar Nov 14 '22 22:11 kaylareopelle

Completed testing documentation examples with Rails7. No issues with any example and Rails7 compatibility.

Docs PR resolving Rails7 warnings: https://github.com/newrelic/docs-website/pull/11056#pullrequestreview-1252544730

hannahramadan avatar Jan 17 '23 23:01 hannahramadan

Closing this issue! I think it remained open by accident.

kaylareopelle avatar Jan 18 '23 19:01 kaylareopelle