Audit existing customer documentation

[kaylareopelle]

Description

Some of our customer documentation hasn't been analyzed by developers familiar with the agent in a long time. We may have outdated or inaccurate information on our site. Let's audit the customer documentation.

Acceptance Criteria

• All code snippets on customer-facing documentation (docs.newrelic.com) pertaining to the Ruby Agent run on modern versions of Ruby and Rails
• All documents include content relevant to the latest version of the agent, or have agent version limitations clearly stated
• Tickets are created for new pieces of documentation that should be added

Design Consideration/Limitations

• If all documents can't be updated, the documents that are updated should be clearly listed and the documents with issues that weren't able to be addressed should be documented for future work

Dependencies

• Docs team for approval/merge
• If we're embarking on this project, we may want to give the docs team a heads up so they have enough bandwidth to edit/assist

Additional context

• This work could be broken into smaller tickets by sections or document

Estimates

M

[workato-integration]

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

[hannahramadan]

Additional resources/info:

• GTS feedback: most confusion comes from custom instrumentation.
• GTS feedback: "We have a good doc on controlling when the agent starts, but it’s in the troubleshooting section, not in the Custom Instrumentation section. So a customer's first step in trying new agent methods would be to try them out in the Ruby console, then they would get stuck and never get to the point of adding it to their code because they thought those methods didn’t work."
• GTS feedback: Once customers started sending up data, how could they find it? We tried to address this in the community ‘Ruby Troubleshooting Guide’ down in the ‘Custom Events, Metrics and Attributes’ section but not everyone would find the post.
• Top Ruby community issues (overtime)
• Top Ruby community issues (past 6 months)
• User feedback may be able to drive documentation updates. [internal link]

Docs ticket:

• Dockerized Ruby APM documentation