Add OSS documentation on the Source Code GitHub integration #4129
Conversation
|
|
||
| ## Verifying the Integration | ||
|
|
||
| The configuration of the GitHub integration is now completed. In order to verify everything works as expected follow the user guide: [Integrate your source code on GitHub with Pyroscope profiling data](../../view-and-analyze-profile-data/line-by-line/). |
There was a problem hiding this comment.
| The configuration of the GitHub integration is now completed. In order to verify everything works as expected follow the user guide: [Integrate your source code on GitHub with Pyroscope profiling data](../../view-and-analyze-profile-data/line-by-line/). | |
| The configuration of the GitHub integration is now completed. In order to verify everything works as expected follow the user guide: [Integrate your source code on GitHub with Pyroscope profiling data](../view-and-analyze-profile-data/line-by-line.md). |
There was a problem hiding this comment.
I don't think this is correct, at least when I use it 404s under make docs/docs. I do think the other link is wrong see 380ad7e
There was a problem hiding this comment.
Yes, .md apparently isn't needed; I think hugo already handled this. Forget about the relative path levels change, that wasn't intended.
simonswine
changed the title
simonswine
changed the title
|
|
||
| This guide walks you through setting up the GitHub integration with minimal permissions for Grafana Pyroscope. | ||
|
|
||
| ## Creating a GitHub App |
There was a problem hiding this comment.
I like that all the steps are right here and broken down nicely. I think it might also be helpful to link to the GitHub app docs: https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app.
These will have more details and cover more edge cases than we might care to do here.
| - Applications in other languages aren't supported | ||
| - eBPF profiled workloads aren't supported |
There was a problem hiding this comment.
Should we convert this to a warning admonition? It would help bring attention to the fact that other languages aren't supported (yet).
simonswine
force-pushed
the
20250422_github-integration-docs
branch
from
2369b3f to
455a928
Compare
This adds and adapts the grafana-cloud Github integration.
Let me know what you think?