Adding README for Sidekiq instrumentation #386
Conversation
AzfaarQureshi
requested review from
dazuma,
ericmustin,
fbogsany,
mwear and
robertlaurin
as code owners
|
|
|
@mwear Good idea! I added a small Examples section. Is this along the lines of what you were thinking? |
| ``` | ||
| ## Examples | ||
|
|
||
| Example usage can be seen in the `./example/sidekiq.rb` file [here](https:/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/sidekiq/example/sidekiq.rb) |
There was a problem hiding this comment.
@mwear is it okay to add a link to the actual file here or is that considered bad practice considering it might become dead if there is ever a code restructure?
There was a problem hiding this comment.
I think it's ok fwiw, will defer to @mwear on any formatting prefs. nice work here @AzfaarQureshi
There was a problem hiding this comment.
👍 this is fine - if we restructure the code, we'll also fix the documentation.
There was a problem hiding this comment.
very minor formatting changes but otherwise lgtm, nice work @AzfaarQureshi
|
@ericmustin oops cant believe I missed the dupe. Thanks for the catch! Its fixed and ready for re-review 😄 |
👍
|
Can you please rebase @AzfaarQureshi ? |
AzfaarQureshi
force-pushed
the
241-add-documentation-for-sidekiq
branch
from
fff7eaf
to
ba9363f
Compare
| [bundler-home]: https://bundler.io | ||
| [bundler-home]: https://bundler.io |
There was a problem hiding this comment.
bundler-home listed twice. Everything looks great.
There was a problem hiding this comment.
Thanks for catching that - it was a problem in another PR too, but I was lulled into ignorance after reviewing a few that didn't have that problem.
This PR adds documentation for OpenTelemetry's Sidekiq Instrumentation, closing #241 . The README describes the Sidekiq gem, installation methods and its license, following the pattern set in instrumentation/sinatra and instrumentation/concurrent_ruby for consistency.