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: remove trailing backtick in verify-config for Loki 3.0 #13640

Merged
merged 2 commits into from
Jul 24, 2024

Conversation

mstrucken
Copy link
Contributor

What this PR does / why we need it:
Fixes a small typo in the documentation. Just copy and pasting the bash command to check the config before upgrading to Loki 3.0 currently doesn't work because of a trailing backtick.

Which issue(s) this PR fixes:

Special notes for your reviewer:

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
  • 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
  • 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

@mstrucken mstrucken requested a review from a team as a code owner July 24, 2024 10:54
@CLAassistant
Copy link

CLAassistant commented Jul 24, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jul 24, 2024
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LGTM, thanks for taking the time to fix this.

@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

1 similar comment
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit 498f29a into grafana:main Jul 24, 2024
62 checks passed
grafanabot pushed a commit that referenced this pull request Jul 24, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit 498f29a)
grafanabot pushed a commit that referenced this pull request Jul 24, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit 498f29a)
@mstrucken mstrucken deleted the patch-1 branch July 25, 2024 07:53
benclive pushed a commit to cyriltovena/loki that referenced this pull request Jul 31, 2024
…13640)

Co-authored-by: J Stickler <julie.stickler@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x size/XS 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.

4 participants