Docs: Organize and edit the LogQL section #4342
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KMiller-Grafana
requested review from
dannykopping,
cyriltovena,
jeschkies,
cstyan,
kavirajk and
owen-d
Co-authored-by: Danny Kopping <dannykopping@gmail.com>
dannykopping
approved these changes
Sep 16, 2021
There was a problem hiding this comment.
LGTM @KMiller-Grafana
Apologies for the prose-related comments; I misread the purpose of this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR applies some organizational changes to the LogQL description. It places the log queries and metric queries sections into distinct pages. There are lots of small changes as well, from using title case on section headers to re-ordering the presentation of the 3 kinds of expressions (filtering, parsing, and formatting) such that like kinds are next to each other. Corrected a few errors I found, as well as made spelling corrections.
There will be at least one more PR to improve the LogQL section, but this PR stops short of the improvements I'd like to make, as there would be too much to review.