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] Fix links for mounting OSS content to GET #4388

Merged

Conversation

knylander-grafana
Copy link
Contributor

@knylander-grafana knylander-grafana commented Nov 27, 2024

What this PR does:

Corrects links and references so the intro, TraceQL, and metrics-generator content can be mounted into GET documentation.

Which issue(s) this PR fixes:
Part of https://github.com/grafana/enterprise-traces/issues/1365
Blocks https://github.com/grafana/website/pull/22927

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Copy link
Contributor

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

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Nothing jumps out after a second scan. Thanks for incorporating my suggestions :)

@knylander-grafana knylander-grafana merged commit 9275d07 into grafana:main Nov 27, 2024
17 checks passed
Copy link
Contributor

The backport to release-v2.6 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-4388-to-release-v2.6 origin/release-v2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 9275d0788a0e1f3ef2633e2a8f4983ec67c523eb

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-4388-to-release-v2.6
# Create the PR body template
PR_BODY=$(gh pr view 4388 --json body --template 'Backport 9275d0788a0e1f3ef2633e2a8f4983ec67c523eb from #4388{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.6] [DOC] Fix links for mounting OSS content to GET' --body-file - --label 'type/docs' --label 'backport' --base release-v2.6 --milestone release-v2.6 --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-4388-to-release-v2.6

# Create a pull request where the `base` branch is `release-v2.6` and the `compare`/`head` branch is `backport-4388-to-release-v2.6`.

# Remove the local backport branch
git switch main
git branch -D backport-4388-to-release-v2.6

knylander-grafana added a commit that referenced this pull request Nov 28, 2024
* Fix links for mounting OSS content to GET

* Fix ref to refs in frontmatter

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/tempo/traceql/metrics-queries/functions.md

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 9275d07)
@knylander-grafana knylander-grafana deleted the fix-links-for-get-mounts-docs branch January 13, 2025 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.6 backport-failed type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants