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 LogCLI topic #15376

Merged
merged 3 commits into from
Dec 13, 2024
Merged

docs: Update LogCLI topic #15376

merged 3 commits into from
Dec 13, 2024

Conversation

JStickler
Copy link
Contributor

What this PR does / why we need it:

Updates the content on the logcli page to

  • better organize content
  • provide more context on what the tool is for
  • add additional examples
  • fix formatting issues/ Vale linter issues

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Dec 11, 2024
@JStickler JStickler requested a review from a team as a code owner December 11, 2024 21:41
Copy link
Contributor

@Jayclifford345 Jayclifford345 left a comment

Choose a reason for hiding this comment

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

Really great rewrite! Only had two suggestions but other than that awsome!

docs/sources/query/logcli/getting-started.md Show resolved Hide resolved
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Dec 13, 2024

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

1 similar comment
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Dec 13, 2024

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

@JStickler JStickler merged commit bc3d994 into main Dec 13, 2024
59 checks passed
@JStickler JStickler deleted the 2024.12.11_LogCLI branch December 13, 2024 18:48
loki-gh-app bot pushed a commit that referenced this pull request Dec 13, 2024
(cherry picked from commit bc3d994)
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Dec 13, 2024

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

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-15376-to-release-3.3.x
# Create the PR body template
PR_BODY=$(gh pr view 15376 --json body --template 'Backport bc3d994ff39a53575d859f2c0c552e8a76c746ba from #15376{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update LogCLI topic (backport release-3.3.x)' --body-file - --label 'size/L' --label 'type/docs' --label 'backport' --base release-3.3.x --milestone release-3.3.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-15376-to-release-3.3.x

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

# Remove the local backport branch
git switch main
git branch -D backport-15376-to-release-3.3.x

JStickler added a commit that referenced this pull request Dec 13, 2024
(cherry picked from commit bc3d994)
JStickler added a commit that referenced this pull request Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.2.x backport release-3.3.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.

2 participants