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

[DOC] Add links to supported profile types in SDKs #3228

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented Apr 18, 2024

Added links to the supported profiling types by language from the SDK and eBPF docs.

Fixes https://github.com/grafana/pyroscope-squad/issues/147

@knylander-grafana knylander-grafana self-assigned this Apr 18, 2024
@knylander-grafana knylander-grafana requested review from a team as code owners April 18, 2024 18:42
@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Apr 18, 2024
@knylander-grafana knylander-grafana changed the title Add links to supported profile types in SDKs [DOC] Add links to supported profile types in SDKs Apr 18, 2024
@knylander-grafana knylander-grafana added the backport release/v1.5 This label will backport a merged PR to the release/v1.5 branch label Apr 18, 2024
Copy link
Contributor

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

Copy link
Contributor

@bryanhuhta bryanhuhta left a comment

Choose a reason for hiding this comment

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

approve

docs/sources/configure-client/language-sdks/_index.md Outdated Show resolved Hide resolved
knylander-grafana and others added 2 commits April 19, 2024 19:12
Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com>
@knylander-grafana knylander-grafana merged commit ecc6374 into grafana:main Apr 19, 2024
16 checks passed
@knylander-grafana knylander-grafana deleted the ps-147-add-profile-type-support-sdks branch April 19, 2024 23:21
github-actions bot pushed a commit that referenced this pull request Apr 19, 2024
* Add links to supported profile types in SDKs

* Update doc

* Fix validator issues with links

* Second fix for relrefs

* Add java config examples

* Apply suggestions from code review

* Apply suggestions from code review

* Added link to configure-client from profiling types

* Fix heading

* Fix links to updated heading

* Apply suggestions from code review

Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com>

---------

Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com>
(cherry picked from commit ecc6374)
Copy link
Contributor

The backport to release/v1.5 failed:

Validation Failed: "Could not resolve to a node with the global id of 'T_kwDOAG3Mbc4AczmP'."

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3228-to-release/v1.5 origin/release/v1.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x ecc6374be59232b6a9c068290e04a0878a9b9655

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-3228-to-release/v1.5
# Create the PR body template
PR_BODY=$(gh pr view 3228 --json body --template 'Backport ecc6374be59232b6a9c068290e04a0878a9b9655 from #3228{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.5] [DOC] Add links to supported profile types in SDKs" --body-file - --label "type/docs" --label "backport" --base release/v1.5 --milestone release/v1.5 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-3228-to-release/v1.5

# Create a pull request where the `base` branch is `release/v1.5` and the `compare`/`head` branch is `backport-3228-to-release/v1.5`.

# Remove the local backport branch
git switch main
git branch -D backport-3228-to-release/v1.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.5 This label will backport a merged PR to the release/v1.5 branch backport-failed 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.

2 participants