Pyroscope task doc

[mattdurham]

PR Description

This is largely a restructuring of https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/go_pull/.

Which issue(s) this PR fixes

Fixes grafana/alloy#293

Notes to the Reviewer

PR Checklist

• Documentation added

[clayton-cornell]

@mattdurham Media assets should be uploaded as described here: https://grafana.com/docs/writers-toolkit/write/image-guidelines/#where-to-store-media-assets

[clayton-cornell]

Some initial doc input. I need to review again once a few of the deeper questions are sorted out. There are still some points that need attention to make this topic more consistent with the other similar topics.

[clayton-cornell]

Suggested change

	3. Add the below configuration to `agent.river` file in the same directory as the file downloaded above.
	3. Add the following configuration to the `agent.river` file in the same directory as the file downloaded above.

I'm confused by this... you download the latest Agent... then save the River config file to the same directory as the downloaded Agent? Why? I would expect to add the config file to the existing config or to the default config location. Am I misunderstanding what's oing on here?

[mattdurham]

There is no default config location, run PATH must always be specified. With the services we do encode that into the service definition. There is no requirement to be in the same directory, but if we assume it is then it makes the commands more copy pastable.

[clayton-cornell]

OK. The wording here still doesn't make sense to me. maybe it'll resolve itself if this is reworked as a task. If we keep or expand it as a tutorial we'd need to fix this up and use the path either as a replaceable variable or explicitly name a location to use for the tutorial.

[thampiotr]

This looks like a tutorial to me. See https://github.com/grafana/agent/blob/main/docs/developer/writing-docs.md

A tutorial:

Provides procedures that users can safely reproduce and learn from. Answers the question: “Can you teach me to …?”

While task:

Tasks are production-ready and contain best practices and recommendations. They are quite detailed, with Reference pages being the only type of documentation that has more detail.

I believe we want a task doc, which will help users configure sending to Pyroscope in production, instead of on a local machine. I know that config is roughly the same, but there's a distinction in our docs now between tasks and tutorials that I'd like to maintain.

cc @clayton-cornell to chime in, if we need a second opinion ;)

[clayton-cornell]

@thampiotr @mattdurham Yes, I was thinking the same thing. That's one of the reasons I want to re-review this PR once some of the questions I raised are cleared up.

I agree, it's more tutorial than task. For the tasks we need to define what the purpose or goal is, and it should generally be a single thing... a single goal such as (only) configure an existing setup to send Pyroscope in production. We make quite a few assumptions such as... Agent is already installed... and we focus on one thing... the configuration needs.

[mattdurham]

Now that I am back to working on this going to rewrite it more task oriented.

[knylander-grafana]

Should we consider removing the PYroscope content or sharing this updated doc back with the Pyroscope doc?

[github-actions]

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!

[knylander-grafana]

@thampiotr There has been a bunch of work on the Pyroscope doc you started with: https://github.com/grafana/pyroscope/blob/main/docs/sources/configure-client/grafana-agent/go_pull.md

Should we see about merging your changes back into the Pyroscope doc and then sharing the content from Pyroscope to Alloy?