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: Update simple scalable mode documentation by adding quotes around the schema config timestamps #13507

Closed
wants to merge 1 commit into from

Conversation

richardvdveen
Copy link

@richardvdveen richardvdveen commented Jul 12, 2024

What this PR does / why we need it:
The from field in schema configurations need to be quoted in the Helm values file, otherwise a time portion is added on a Helm install leading to errors. The documentation shows examples without quotes.

Which issue(s) this PR fixes:
No recorded issue, this is a minor fix to the documentation that has been added for other deployment modes already.

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

The `from` field in schema configurations need to be quoted in the Helm values file, otherwise a time portion is added on a Helm install leading to errors.
@richardvdveen richardvdveen requested a review from a team as a code owner July 12, 2024 11:51
@CLAassistant
Copy link

CLAassistant commented Jul 12, 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 12, 2024
@richardvdveen richardvdveen changed the title Update _index.md by adding quotes around the timestamps docs: update simple scalable mode documentation by adding quotes around the schema config timestamps Jul 12, 2024
@richardvdveen richardvdveen changed the title docs: update simple scalable mode documentation by adding quotes around the schema config timestamps docs: Update simple scalable mode documentation by adding quotes around the schema config timestamps Jul 12, 2024
@JStickler
Copy link
Contributor

Hi @richardvdveen, could you also update line 221 please? And thanks for taking the time to update the docs.

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