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

Revise portions of the docs LogQL section #4012

Merged
merged 2 commits into from
Jul 22, 2021

Conversation

KMiller-Grafana
Copy link
Contributor

This the first of what may be many PRs to update the docs section on LogQL. This PR improves the phrasing and presentation of many examples. It introduces a diagram to show the structure of a query. It standardizes some use of terms, and it relies a little bit less on readers who are familiar with PromQL.

@KMiller-Grafana KMiller-Grafana requested review from cyriltovena and a team July 19, 2021 22:04
Copy link
Contributor

@jeschkies jeschkies left a comment

Choose a reason for hiding this comment

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

🙏 this is pretty awesome. Unfortunately I cannot judge all content but this is much easier to understand.

docs/sources/logql/_index.md Show resolved Hide resolved
Comment on lines +177 to +179
For example,
while the results will be the same,
the query specified with
Copy link
Contributor

Choose a reason for hiding this comment

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

This would be an example 🙂

Copy link
Contributor

@cyriltovena cyriltovena left a comment

Choose a reason for hiding this comment

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

LGTM

@cyriltovena cyriltovena merged commit 391984d into grafana:main Jul 22, 2021
@KMiller-Grafana KMiller-Grafana deleted the docs/revise-LogQL branch July 22, 2021 22:22

#### Offset modifier
Copy link
Contributor

Choose a reason for hiding this comment

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

The Offset modifier section got lost in this PR.

kb000 added a commit to kb000/loki that referenced this pull request Oct 18, 2023
Bring back offset modifier doc section from grafana#3455 and lost in  grafana#4012
@kb000 kb000 mentioned this pull request Oct 18, 2023
7 tasks
JStickler pushed a commit that referenced this pull request Oct 19, 2023
Bring back offset modifier doc section from
#3455 and lost in
#4012

**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes regression from #2785

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [x] Documentation added
- [ ] Tests updated **N/A**
- [ ] `CHANGELOG.md` updated  **N/A**
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label **N/A**
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md` **N/A**
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
**N/A**
grafanabot pushed a commit that referenced this pull request Oct 19, 2023
Bring back offset modifier doc section from
#3455 and lost in
#4012

**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes regression from #2785

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [x] Documentation added
- [ ] Tests updated **N/A**
- [ ] `CHANGELOG.md` updated  **N/A**
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label **N/A**
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md` **N/A**
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
**N/A**

(cherry picked from commit 8645519)
JStickler pushed a commit that referenced this pull request Oct 19, 2023
Backport 8645519 from #10960

---

Bring back offset modifier doc section from
#3455 and lost in
#4012

**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes regression from #2785

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [x] Documentation added
- [ ] Tests updated **N/A**
- [ ] `CHANGELOG.md` updated  **N/A**
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label **N/A**
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md` **N/A**
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
**N/A**

Co-authored-by: Kevin Burek <kb000@users.noreply.github.com>
rhnasc pushed a commit to inloco/loki that referenced this pull request Apr 12, 2024
Bring back offset modifier doc section from
grafana#3455 and lost in
grafana#4012

**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes regression from grafana#2785

**Special notes for your reviewer**:

**Checklist**
- [x] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [x] Documentation added
- [ ] Tests updated **N/A**
- [ ] `CHANGELOG.md` updated  **N/A**
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label **N/A**
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md` **N/A**
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](grafana@d10549e)
**N/A**
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants