-
Notifications
You must be signed in to change notification settings - Fork 487
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 to clarify what various components are used for #6182
base: main
Are you sure you want to change the base?
Conversation
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 haven't mentioned some components yet:
discovery.*
remote.*
- pyroscope.java
- pyroscope.ebpf
- faro.receiver
I'm worried that this page is starting to get really long. Maybe we could make it a totally separate page?
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 would start with the single page in draft and split only if needed. As it is, each section is fairly small
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.
But... as I read it we are getting really deep with the heading levels. I would suggest we break this off the index and just have it as its own standalone page. That might help reduce the empty heading overload that the current draft has (we should avoid having a heading immediately followed by another heading with no text in between the headings).
This PR has not had any activity in the past 30 days, so the |
I'd like the new docs to be the place we refer people when someone asks whether the Agent can do something, or whether it can be used in a certain situation with a certain telemetry. We currently don't have a doc which lists all of this info, and we need to rephrase it manually in conversations.
This PR is a draft because I am not sure of the best location for this, and I'm not sure how it is best represented.