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

chore(examples): Update release-1.10 with changes from /docs #3787

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

simonswine
Copy link
Contributor

@simonswine simonswine commented Dec 17, 2024

We did not always backport the changes, also there was quite a few that were not that atomic.

I suggest we do this: Takes the changes from /docs in main and commit them to the release branch.

Wdyt?

@simonswine simonswine marked this pull request as ready for review December 17, 2024 08:41
@simonswine simonswine requested review from a team as code owners December 17, 2024 08:41
@@ -64,6 +64,8 @@ Check your specific language SDK documentation for the exact configuration optio

The examples in this section provide samples you can use as a starting point for your own configurations.

Explore the [example](https://github.com/grafana/pyroscope/tree/main/examples/language-sdk-instrumentation/golang-push/rideshare-alloy) in our GitHub repository to learn how to configure Grafana Alloy to receive profiles from a Golang application instrumented with Pyroscope.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing "our" in the sentence because we try not to use first person (we, I) in the docs except for things like release notes.

Suggested change
Explore the [example](https://github.com/grafana/pyroscope/tree/main/examples/language-sdk-instrumentation/golang-push/rideshare-alloy) in our GitHub repository to learn how to configure Grafana Alloy to receive profiles from a Golang application instrumented with Pyroscope.
Explore the [example](https://github.com/grafana/pyroscope/tree/main/examples/language-sdk-instrumentation/golang-push/rideshare-alloy) in the Pyroscope GitHub repository to learn how to configure Grafana Alloy to receive profiles from a Golang application instrumented with Pyroscope.

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 will provide a separate PR for that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for backporting and updating the docs! It's a good thing to make sure we have the updates visible in our current docs.

@knylander-grafana knylander-grafana added type/docs Improvements for doc docs. Used by Docs team for project management backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch and removed backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch labels Dec 17, 2024
Copy link
Contributor

This PR must be merged before a backport PR will be created.

@simonswine simonswine merged commit 0e897c0 into release/v1.10 Jan 2, 2025
20 checks passed
@simonswine simonswine deleted the 20241217_docs-update branch January 2, 2025 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants