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

fix: Improve docs for min and max table offsets (backport k227) #14929

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

loki-gh-app[bot]
Copy link
Contributor

@loki-gh-app loki-gh-app bot commented Nov 14, 2024

Backport fd9d332 from #14890


What this PR does / why we need it:
The docs for min and max offsets are a bit difficult to reason about. This PR improves them with examples and sets the default min offset to 0 (build from today), and the max to 1 (build till tomorrow).

We also add a test for the tables iterator.

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

Co-authored-by: Christian Haudum <[email protected]>
(cherry picked from commit fd9d332)
@loki-gh-app loki-gh-app bot requested a review from a team as a code owner November 14, 2024 16:29
@loki-gh-app loki-gh-app bot added backport size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Nov 14, 2024
@loki-gh-app loki-gh-app bot requested a review from salvacorts November 14, 2024 16:29
@salvacorts salvacorts merged commit 3161fdc into k227 Nov 14, 2024
66 checks passed
@salvacorts salvacorts deleted the backport-14890-to-k227 branch November 14, 2024 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport size/M 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.

1 participant