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] Clarify which URL to use with profilecli #3526

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Conversation

bryanhuhta
Copy link
Contributor

We recently ran into a case where a customer wanted to use profilecli but was using the wrong URL. This PR updates the docs to make it more clear which URL to use (and which one not to use).

Screenshot 2024-08-28 at 4 01 24 PM

@bryanhuhta bryanhuhta self-assigned this Aug 28, 2024
@bryanhuhta bryanhuhta requested review from a team as code owners August 28, 2024 23:04
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 updating the docs! Just a few minor suggestions and a clarification request.

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

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

bryanhuhta and others added 2 commits August 28, 2024 18:38
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
@bryanhuhta bryanhuhta merged commit 7709a22 into main Aug 29, 2024
18 checks passed
@bryanhuhta bryanhuhta deleted the profilecli-docs branch August 29, 2024 00:08
github-actions bot pushed a commit that referenced this pull request Aug 29, 2024
Copy link
Contributor

The backport to release/v1.7 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-3526-to-release/v1.7 origin/release/v1.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 7709a22c080258e51efff531cb55b74750d9c209

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-3526-to-release/v1.7
# Create the PR body template
PR_BODY=$(gh pr view 3526 --json body --template 'Backport 7709a22c080258e51efff531cb55b74750d9c209 from #3526{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release/v1.7] [docs] Clarify which URL to use with profilecli' --body-file - --label 'type/docs' --label 'backport' --base release/v1.7 --milestone release/v1.7 --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-3526-to-release/v1.7

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

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

bryanhuhta added a commit that referenced this pull request Aug 30, 2024
(cherry picked from commit 7709a22)

Co-authored-by: Bryan Huhta <32787160+bryanhuhta@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.7 This label will backport a merged PR to the release/v1.7 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