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 approx_topk documentation #16223

Merged
merged 4 commits into from
Mar 11, 2025
Merged

docs: Update approx_topk documentation #16223

merged 4 commits into from
Mar 11, 2025

Conversation

09jvilla
Copy link
Contributor

Added a little more content to how the approx_topk works that was previously only in the release notes.

Please backport to Loki 3.3 docs when complete.

Signed-off-by: Jennifer Villa <[email protected]>
@09jvilla 09jvilla requested a review from a team as a code owner February 12, 2025 18:03
@09jvilla 09jvilla requested a review from JStickler February 12, 2025 18:04
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Feb 12, 2025
@09jvilla 09jvilla requested a review from jeschkies February 12, 2025 18:04
@09jvilla
Copy link
Contributor Author

@jeschkies -- Can we get a review for technical accuracy when you have a chance? Some of this was in the release notes but felt more appropriate in the LogQL docs.

Copy link
Contributor

github-actions bot commented Feb 12, 2025

💻 Deploy preview deleted.

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] I think we still want to mention that we're talking about the top 1,000 elements, but other than that, looks good.

Fixed typo

Co-authored-by: J Stickler <[email protected]>
Signed-off-by: Jennifer Villa <[email protected]>
Updating per Karsten's input.

Signed-off-by: Jennifer Villa <[email protected]>
@09jvilla 09jvilla requested review from jeschkies and JStickler March 10, 2025 15:26
@09jvilla
Copy link
Contributor Author

@jeschkies , re-requesting a review now that I incorporated your feedback! Let me know.

@JStickler JStickler changed the title Update approx_topk documentation docs: Update approx_topk documentation Mar 11, 2025
@JStickler JStickler merged commit 541e93c into main Mar 11, 2025
62 checks passed
@JStickler JStickler deleted the 09jvilla-patch-1 branch March 11, 2025 13:02
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Mar 11, 2025

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-16223-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 541e93c157721a0634254b1846ad0f214f8f36df

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-16223-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 16223 --json body --template 'Backport 541e93c157721a0634254b1846ad0f214f8f36df from #16223{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update `approx_topk` documentation (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-16223-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-16223-to-release-3.1.x`.

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

loki-gh-app bot pushed a commit that referenced this pull request Mar 11, 2025
Signed-off-by: Jennifer Villa <[email protected]>
Signed-off-by: Jennifer Villa <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 541e93c)
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Mar 11, 2025

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

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-16223-to-release-3.2.x
# Create the PR body template
PR_BODY=$(gh pr view 16223 --json body --template 'Backport 541e93c157721a0634254b1846ad0f214f8f36df from #16223{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update `approx_topk` documentation (backport release-3.2.x)' --body-file - --label 'size/S' --label 'type/docs' --label 'backport' --base release-3.2.x --milestone release-3.2.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-16223-to-release-3.2.x

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

# Remove the local backport branch
git switch main
git branch -D backport-16223-to-release-3.2.x

loki-gh-app bot pushed a commit that referenced this pull request Mar 11, 2025
Signed-off-by: Jennifer Villa <[email protected]>
Signed-off-by: Jennifer Villa <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 541e93c)
@09jvilla
Copy link
Contributor Author

Julie, thanks for helping me get this released!

JoaoBraveCoding pushed a commit to JoaoBraveCoding/loki that referenced this pull request Mar 12, 2025
Signed-off-by: Jennifer Villa <[email protected]>
Signed-off-by: Jennifer Villa <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.3.x backport release-3.4.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