distro selection docs #2788
distro selection docs #2788
Conversation
| - `distro` specifies which distro should be loaded. Argument should be the entry | ||
| point name of the desired distro. If only a single distro exists, this | ||
| argument may be left out. | ||
| - `configurator` specifies which configurator should be loaded. Argument should | ||
| be the entry point name of the desired configurator. If only a single | ||
| configurator exists, this argument may be left out. |
There was a problem hiding this comment.
for someone who is not involved with the python SIG I have no idea what this should mean. What other distros are there available? What is the difference here? Are we talking about vendor-specific distros or something else?
Same for the configurator, what options to I have and why would I choose another one?
There was a problem hiding this comment.
+1 even as someone involved I don't remember what distro vs configurator is. Would be nice to have something explaining what they are.
There was a problem hiding this comment.
We do have documentation (at least for distros) here. I'm not sure this is the place where we should document what a distro or a configurator is. We don't do any explanation for --traces_exporter or --metrics_exporter either.
Maybe just a link to the general documentation would be enough here?
There was a problem hiding this comment.
I always found the distros page you linked confusing because it replicates a lot of what is written in the automatic documentation, so we need to merge them eventually. Also, Python is the only language as far as I am aware that has this understanding of a distribution.
I have no issue with distro and configurator being documented as outlined here, but what we need is examples what options I have as an enduser, if there are currently only 1 option and they will come later, then let's postpone this for now and add it when people have a choise.
We don't do any explanation for --traces_exporter or --metrics_exporter either.
We could have them.
|
The other thing is that I don't like having to list out all of these options unless necessary. Are there defaults (like |
|
@open-telemetry/python-maintainers / @open-telemetry/python-approvers I leave it to you if/when we add this to the docs, please provide guidance |
Yes the base distro that can also be referred to as the "distro" entry point is the default. |
|
@jeremydvoss sorry, I'm not sure I understand. Is the option |
|
Closing due to inactivity |
Updating website docs for auto instrumentation with respect this this pr: open-telemetry/opentelemetry-python-contrib#1823