Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ✏️ Sidekiq instrumentation options #824

Merged
merged 4 commits into from
Jan 18, 2024
Merged

docs: ✏️ Sidekiq instrumentation options #824

merged 4 commits into from
Jan 18, 2024

Conversation

kohbis
Copy link
Contributor

@kohbis kohbis commented Jan 18, 2024

For users of Sidekiq instrumentation, I thought it would be nice to have a list of options and their uses.
So I added a (simple explain and format) table in the README ✏️
(At least no code reading required)

I improve any further explanations, items, or errors that are necessary.

If you don't need it, you can close it 🙏

end
```

|name|type|default|description|
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ Thank you!

Copy link
Collaborator

@arielvalentin arielvalentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution!

If you are curious and would be interested in helping us a little more in this area, I would be interested in seeing if we could somehow generate this markdown README as well as some yardoc that may appear here:

https://www.rubydoc.info/gems/opentelemetry-instrumentation-sidekiq/OpenTelemetry/Instrumentation/Sidekiq/Instrumentation

That way we could ensure our docs are up-to-date with the options we provide.

Is that something that would interest you?

@kohbis
Copy link
Contributor Author

kohbis commented Jan 18, 2024

@arielvalentin Thank you for confirming!

If you are curious and would be interested in helping us a little more in this area, I would be interested in seeing if we could somehow generate this markdown README as well as some yardoc that may appear here:

Sorry, I missed the mention of Yard in the Contribute guide.
I don't know how to output to README, I will first rewrite it from README to Yard so that users can check it in rubydoc 🙏 (in this PR)

@kohbis
Copy link
Contributor Author

kohbis commented Jan 18, 2024

@arielvalentin I moved from README to Yard.

How about this?
simple: a06d84e
each format macro: c4c42cf

@arielvalentin
Copy link
Collaborator

Thank you for taking the time to do that!

@arielvalentin arielvalentin merged commit 1c10d02 into open-telemetry:main Jan 18, 2024
46 of 47 checks passed
@arielvalentin
Copy link
Collaborator

@kohbis Would you be interested and available to help us do the same for other instrumentations?

@kohbis kohbis deleted the doc-for-sidekiq-options branch January 18, 2024 12:42
@kohbis
Copy link
Contributor Author

kohbis commented Jan 18, 2024

@kohbis Would you be interested and available to help us do the same for other instrumentations?

@arielvalentin
If you don't mind if I proceed a little at a time, I'd be happy to help 🙏
And there were omissions could you please confirm it? 🙇
#825

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants