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 page weights for the table of contents #3301

Merged

Conversation

knylander-grafana
Copy link
Contributor

This doc PR does several things:

  • Fixes a few minor linting issues
  • Corrects the page weight for the table of contents
  • Updates some text to use Alloy and Agent
  • Added the Alloy admonition to one of the pages

@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label May 16, 2024
@knylander-grafana knylander-grafana self-assigned this May 16, 2024
@knylander-grafana knylander-grafana requested review from a team as code owners May 16, 2024 01:56
@knylander-grafana knylander-grafana added the backport release/v1.5 This label will backport a merged PR to the release/v1.5 branch label May 16, 2024
Copy link
Contributor

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

Copy link
Contributor

@simonswine simonswine left a comment

Choose a reason for hiding this comment

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

LGTM

@knylander-grafana knylander-grafana merged commit eb9dd3c into grafana:main May 16, 2024
18 checks passed
@knylander-grafana knylander-grafana deleted the fix-page-weights-toc branch May 16, 2024 14:37
github-actions bot pushed a commit that referenced this pull request May 16, 2024
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-3301-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 eb9dd3c9604cf8706f334841312d43cc0bc9d427

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-3301-to-release/v1.5
# Create the PR body template
PR_BODY=$(gh pr view 3301 --json body --template 'Backport eb9dd3c9604cf8706f334841312d43cc0bc9d427 from #3301{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.5] [DOC] Fix page weights for the table of contents" --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-3301-to-release/v1.5

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

# Remove the local backport branch
git switch main
git branch -D backport-3301-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