Skip to content

docs: Troubleshooting query docs #20182

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.

Sign up for GitHub

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

Jump to bottom
Open
JStickler wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Troubleshooting query docs #20182

JStickler wants to merge 3 commits into from
+1,477 −0

Conversation

@JStickler
Copy link
Contributor

@JStickler JStickler commented Dec 9, 2025

What this PR does / why we need it:

  • Creates a new folder for troubleshooting in the TOC and renames the current troubleshooting topic.
  • Adds a new shared topic, Troubleshooting Queries.
  • Publishes the shared topic under Query/ Troubleshooting Queries and under Manage/Troubleshooting/Troubleshoot Queries.

Related PR: #20092

Special notes for your reviewer:

AI authored using VSCode + VSCode + Claude Sonnet 4 and Cursor + Claude Sonnet 4.5. Two different drafts were generated, then merged and standardized.

Prompts:

  • Acting as an experienced technical writer with knowledge of Loki, write a troubleshooting guide for querying logs stored in Loki. Using error messages in the code base, including LogQL and LogCLI, document Loki’s error messages, the causes, and what users should do when encountering errors querying logs.
  • Using the following structure: Error message, Cause, Resolution, Properties, fill in any missing details in troubleshooting-query.md. If there are additional sections, for example Configuration Reference, leave them in the document.

@JStickler JStickler requested a review from a team as a code owner December 9, 2025 16:50
@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Dec 9, 2025
@JStickler JStickler mentioned this pull request Dec 9, 2025
Open
6 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2025 •
edited
Loading

💻 Deploy preview available (docs: Troubleshooting query docs):

@JStickler JStickler force-pushed the 2025.12.08_tr-query branch from b6e82c0 to ea2f6e0 Compare December 9, 2025 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

size/XXL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JStickler