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

(chore): remove incorrect cache config preample #8859

Merged

Conversation

dannykopping
Copy link
Contributor

With the addition of the config generation tool, a comment prefix was added for all cache types:

Cache config for index entry writing.
https://grafana.com/docs/loki/next/configuration/#cache_config

This appears in the description of each cache config option, and is misleading.

The likely explanation is that we have 4 different cache types who all register the same flags, and the last one got precedence

I noticed this while reviewing #8852.

With the addition of the config generation tool, a comment prefix was added for all cache types

The likely explanation is that we have 4 different cache types who all register the same flags, and the last one got precedence

Signed-off-by: Danny Kopping <danny.kopping@grafana.com>
@dannykopping dannykopping requested review from JStickler and a team as code owners March 21, 2023 19:15
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Mar 21, 2023
@grafanabot
Copy link
Collaborator

Hello @dannykopping!
Backport pull requests need to be either:

  • Pull requests which address bugs,
  • Urgent fixes which need product approval, in order to get merged,
  • Docs changes.

Please, if the current pull request addresses a bug fix, label it with the type/bug label.
If it already has the product approval, please add the product-approved label. For docs changes, please add the type/docs label.
If none of the above applies, please consider removing the backport label and target the next major/minor release.
Thanks!

@dannykopping dannykopping added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories and removed missing-labels type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Mar 21, 2023
Copy link
Collaborator

@trevorwhitney trevorwhitney left a comment

Choose a reason for hiding this comment

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

lgtm

@dannykopping dannykopping merged commit 2d93952 into grafana:main Mar 22, 2023
@dannykopping dannykopping deleted the dannykopping/fix-cache-comments branch March 22, 2023 06:44
grafanabot pushed a commit that referenced this pull request Mar 22, 2023
With the addition of the [config generation
tool](#7916), a comment prefix was
added for all cache types:

`Cache config for index entry writing.`
https://grafana.com/docs/loki/next/configuration/#cache_config

This appears in the description of each cache config option, and is
misleading.

(cherry picked from commit 2d93952)
dannykopping pushed a commit that referenced this pull request Mar 22, 2023
Backport 2d93952 from #8859

Co-authored-by: Danny Kopping <danny.kopping@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.8.x size/L 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