-
Notifications
You must be signed in to change notification settings - Fork 1k
Add distro's introduction to README.md #13470
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
Conversation
README.md
Outdated
|
|
||
| ## Creating agent distribution | ||
|
|
||
| [Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| [Distro](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. | |
| The [Distro documentation](examples/distro/README.md) provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I used same hyperlink format with
opentelemetry-java-instrumentation/README.md
Lines 102 to 105 in 826ba74
| [Extensions](examples/extension/README.md) add new features and capabilities to the agent without | |
| having to create a separate distribution or to fork this repository. For example, you can create | |
| custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a | |
| single jar file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the extensions sentence flows nicely, but “Distro” alone being treated as the subject of the sentence feels a little ambiguous as to what “Distro” refers to. On the other hand, the links are for examples as opposed to documentation, so maybe i'm over thinking it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the links are for examples as opposed to documentation
How about using Distribution instead of Distro here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the extension paragraph and this new one feel a little bit different.
This extensions paragraph feels like it is describing the function of an extension, and not necessarily describing the contents of what the link is taking you to.
Extensions add new features and capabilities to the agent without
having to create a separate distribution or to fork this repository. For example, you can create
custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a
single jar file.
In contrast, the new paragraph seems to be more describing the contents of the the link as opposed to stricly what the custom distribution functionality enables.
Distro provides guidance on creating a separate distribution, serving as a collection of examples for extending the functionality of the OpenTelemetry Java instrumentation agent. It also demonstrates how to repackage the agent while incorporating custom features.
I think if we wanted to take the same approach in the distro section, we could do something like:
A custom distribution allows you to extend and repackage the Opentelemetry Java instrumentation agent in order to incorporate custom features.
With that being said, what you currently have is also probably ok
Co-authored-by: Jay DeLuca <[email protected]>
trask
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @steverao!
my only thought is distros are a pretty advanced concept and mainly targeted for observability vendors as opposed to end users
did you have a particular audience, discoverability problem in mind here?
Yes, compared with some ordinary users, it's really more useful for observability vendors or middle/large-size businesses that they want to do some customizations. If we don't add related content to more obvious place such as README.md. IMO, it isn't easy to find it. In fact, I don't notice it at first😅 |
Co-authored-by: Trask Stalnaker <[email protected]>
No description provided.