docs: Update Get-Started Labels #13188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs: Update Get-Started Labels Description The current section on "Getting Started with Labels" provides several YAML configuration examples. For newcomers, it is not immediately clear that these examples pertain to configurations for log collectors like Promtail/Alloy, rather than Loki itself. This can lead to confusion about where and how to apply these configurations. Clarifying this in the documentation will enhance its accessibility and usability, particularly for those new to Loki and its ecosystem. Proposed Change Add a brief note at the beginning of the section stating these examples are meant for log collector configurations, such as Promtail/Alloy.
|
|
github-actions
bot
added
the
type/docs
JStickler
approved these changes
Jun 11, 2024
|
This PR must be merged before a backport PR will be created. |
1 similar comment
|
This PR must be merged before a backport PR will be created. |
grafanabot
pushed a commit
that referenced
this pull request
Jun 11, 2024
(cherry picked from commit a08ee68)
7 tasks
grafanabot
pushed a commit
that referenced
this pull request
Jun 11, 2024
(cherry picked from commit a08ee68)
7 tasks
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: Update Get-Started Labels
Description
The current section on "Getting Started with Labels" provides several YAML configuration examples. For newcomers, it is not immediately clear that these examples pertain to configurations for log collectors like Promtail/Alloy, rather than Loki itself. This can lead to confusion about where and how to apply these configurations. Clarifying this in the documentation will enhance its accessibility and usability, particularly for those new to Loki and its ecosystem.
Proposed Change
Add a brief note at the beginning of the section clarifying that these examples are meant for log collector configurations, such as Promtail/Alloy.
Issue(s) this PR fixes
Fixes: #13187
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR