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 to clarify what various components are used for #6182

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ptodev
Copy link
Contributor

@ptodev ptodev commented Jan 18, 2024

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.

@ptodev ptodev marked this pull request as draft January 18, 2024 11:45
Copy link
Contributor Author

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:

I'm worried that this page is starting to get really long. Maybe we could make it a totally separate page?

Copy link
Contributor

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

Copy link
Contributor

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).

@ptodev
Copy link
Contributor Author

ptodev commented Jan 18, 2024

I think the ToC looks nice with the proposed titles:
Screenshot 2024-01-18 at 11 52 09

Copy link
Contributor

This PR has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If you do not have enough time to follow up on this PR or you think it's no longer relevant, consider closing it.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your PR will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!

@github-actions github-actions bot added the needs-attention An issue or PR has been sitting around and needs attention. label Feb 20, 2024
@rfratto rfratto added variant/flow Relatd to Grafana Agent Flow. type/docs Docs Squad label across all Grafana Labs repos labels Apr 9, 2024
@github-actions github-actions bot removed the needs-attention An issue or PR has been sitting around and needs attention. label Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos variant/flow Relatd to Grafana Agent Flow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants