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: Update components.md #fix some typos #14612

Merged
merged 4 commits into from
Nov 27, 2024

Conversation

Piyush-r-bhaskar
Copy link
Contributor

@Piyush-r-bhaskar Piyush-r-bhaskar commented Oct 24, 2024

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Piyush-r-bhaskar Piyush-r-bhaskar requested a review from a team as a code owner October 24, 2024 17:51
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Oct 24, 2024
@Piyush-r-bhaskar Piyush-r-bhaskar changed the title Update components.md #fix some typos doc: Update components.md #fix some typos Oct 24, 2024
@Piyush-r-bhaskar Piyush-r-bhaskar changed the title doc: Update components.md #fix some typos docs: Update components.md #fix some typos Oct 24, 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] Thanks for taking the time to update the docs.

docs/sources/get-started/components.md Outdated Show resolved Hide resolved
docs/sources/get-started/components.md Outdated Show resolved Hide resolved
docs/sources/get-started/components.md Outdated Show resolved Hide resolved
@chaudum
Copy link
Contributor

chaudum commented Nov 27, 2024

@JStickler Can you take another look?

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]

@JStickler JStickler merged commit a412009 into grafana:main Nov 27, 2024
59 checks passed
loki-gh-app bot pushed a commit that referenced this pull request Nov 27, 2024
Co-authored-by: Christian Haudum <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit a412009)
loki-gh-app bot pushed a commit that referenced this pull request Nov 27, 2024
Co-authored-by: Christian Haudum <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit a412009)
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Nov 27, 2024

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

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-14612-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 14612 --json body --template 'Backport a412009d77de4d18ad2cb4d133338ee2b1155150 from #14612{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update components.md #fix some typos (backport release-3.1.x)' --body-file - --label 'size/S' --label 'type/docs' --label 'backport' --base release-3.1.x --milestone release-3.1.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-14612-to-release-3.1.x

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

# Remove the local backport branch
git switch main
git branch -D backport-14612-to-release-3.1.x

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Nov 27, 2024

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

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-14612-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14612 --json body --template 'Backport a412009d77de4d18ad2cb4d133338ee2b1155150 from #14612{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update components.md #fix some typos (backport release-3.0.x)' --body-file - --label 'size/S' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.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-14612-to-release-3.0.x

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

# Remove the local backport branch
git switch main
git branch -D backport-14612-to-release-3.0.x

JStickler pushed a commit that referenced this pull request Nov 27, 2024
Co-authored-by: Christian Haudum <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit a412009)
JStickler pushed a commit that referenced this pull request Nov 27, 2024
Co-authored-by: Christian Haudum <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit a412009)
JStickler added a commit that referenced this pull request Nov 27, 2024
JStickler added a commit that referenced this pull request Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport release-3.3.x backport-failed size/S 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.

3 participants