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: Fix typos and style #13230

Merged
merged 2 commits into from
Jun 20, 2024
Merged

docs: Fix typos and style #13230

merged 2 commits into from
Jun 20, 2024

Conversation

jdbaldry
Copy link
Member

  • Use product name in title
  • Clean up whitespace
  • Simplify some language
  • Fix 'Grafana' typo and avoid product possessive
  • Use repetitive numbering

- Use product name in title
- Clean up whitespace
- Simplify some language
- Fix 'Grafana' typo and avoid product possessive
- Use repetitive numbering

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry requested a review from a team as a code owner June 17, 2024 09:55
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jun 17, 2024
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

{docs team] LGTM

@JStickler JStickler changed the title Fix typos and style docs: Fix typos and style Jun 17, 2024
@grafanabot
Copy link
Collaborator

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

1 similar comment
@grafanabot
Copy link
Collaborator

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

@chaudum chaudum merged commit bbc50fd into main Jun 20, 2024
61 checks passed
@chaudum chaudum deleted the jdb/2024-06-drive-by-style-cleanup branch June 20, 2024 10:08
@grafanabot
Copy link
Collaborator

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

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-13230-to-release-2.9.x
# Create the PR body template
PR_BODY=$(gh pr view 13230 --json body --template 'Backport bbc50fdd5125348b0cae30b0b10aff952a19f29b from #13230{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-2.9.x] docs: Fix typos and style' --body-file - --label 'size/L' --label 'type/docs' --label 'backport' --base release-2.9.x --milestone release-2.9.x --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-13230-to-release-2.9.x

# Create a pull request where the `base` branch is `release-2.9.x` and the `compare`/`head` branch is `backport-13230-to-release-2.9.x`.

# Remove the local backport branch
git switch main
git branch -D backport-13230-to-release-2.9.x

grafanabot pushed a commit that referenced this pull request Jun 20, 2024
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit bbc50fd)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.9.x backport release-3.0.x backport-failed size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants