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

docs: Fix typos in limits.go #15840

Merged
merged 2 commits into from
Jan 24, 2025
Merged

docs: Fix typos in limits.go #15840

merged 2 commits into from
Jan 24, 2025

Conversation

eneiss
Copy link
Contributor

@eneiss eneiss commented Jan 18, 2025

What this PR does / why we need it:
This PR fixes two small typos in the Loki configuration documentation.

Which issue(s) this PR fixes:
None

Special notes for your reviewer:
None

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

@eneiss eneiss requested a review from a team as a code owner January 18, 2025 04:15
@CLAassistant
Copy link

CLAassistant commented Jan 18, 2025

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 Jan 18, 2025
@JStickler
Copy link
Contributor

Hi @eneiss , the Loki configuration file https://grafana.com/docs/loki/latest/configure/
Is automatically generated from code comments and the template found in https://github.com/grafana/loki/blob/main/docs/templates/configuration.template.

In this case, the typo is in the file loki/pkg/validation/limits.go

@eneiss
Copy link
Contributor Author

eneiss commented Jan 23, 2025

Hi @JStickler, sorry for the confusion and thanks for the explanation!
I added my changes to limits.go and kept them in configuration.md since make doc from the repo root did not create any additional change.
Please let me know if that's not what should be done, and thanks for your help :)

@eneiss eneiss changed the title docs: Fix typos in configuration.md docs: Fix typos in limits.go Jan 23, 2025
@JStickler JStickler merged commit 878727d into grafana:main Jan 24, 2025
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants