Doc fixes: remove typos and long sentence #2586
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
|
|
Codecov Report
@@ Coverage Diff @@
## master #2586 +/- ##
==========================================
+ Coverage 63.01% 63.07% +0.05%
==========================================
Files 169 169
Lines 15005 15005
==========================================
+ Hits 9456 9464 +8
+ Misses 4796 4791 -5
+ Partials 753 750 -3
|
oddlittlebird
suggested changes
Sep 1, 2020
| @@ -336,10 +336,9 @@ kubernetes_sd_configs: | |||
|
|
|||
| ### pipeline_stages | |||
|
|
|||
| The [pipeline](../pipelines/) stages (`pipeline_stages`) is used to transform | |||
| log entries and their labels after discovery and consists of a list of any of the items listed below. | |||
| [Pipeline](../pipelines/) stages are used to transform log entries and their labels. The pipline is executed after the discovery process finishes. The `pipeline_stages` object consists of a list of stages which correspond to the items listed below. | |||
There was a problem hiding this comment.
Suggested change
| [Pipeline](../pipelines/) stages are used to transform log entries and their labels. The pipline is executed after the discovery process finishes. The `pipeline_stages` object consists of a list of stages which correspond to the items listed below. | |
| [Pipeline](../pipelines/) stages are used to transform log entries and their labels. The pipeline is executed after the discovery process finishes. The `pipeline_stages` object consists of a list of stages which correspond to the items listed below. |
|
|
||
| Stages serve several purposes, more detail can be found [here](../pipelines/), however generally you extract data with `regex` or `json` stages into a temporary map which can then be use as `labels` or `output` or any of the other stages aside from `docker` and `cri` which are explained in more detail below. | ||
| Stages serve several purposes, more detail can be found [here](../pipelines/). However in most cases you extract data from logs with `regex` or `json` stages. The extracted data is transformed into a temporary map object. The data can then be used by promtail e.g. as values for `labels` or as an `output`. Additionally any other stage aside from `docker` and `cri` can access the extracted data. |
There was a problem hiding this comment.
Suggested change
| Stages serve several purposes, more detail can be found [here](../pipelines/). However in most cases you extract data from logs with `regex` or `json` stages. The extracted data is transformed into a temporary map object. The data can then be used by promtail e.g. as values for `labels` or as an `output`. Additionally any other stage aside from `docker` and `cri` can access the extracted data. | |
| Stages serve several purposes, more detail can be found [here](../pipelines/). | |
| In most cases, you extract data from logs with `regex` or `json` stages. The extracted data is transformed into a temporary map object. The data can then be used by promtail, e.g. as values for `labels` or as an `output`. Additionally any other stage aside from `docker` and `cri` can access the extracted data. |
There was a problem hiding this comment.
Best practice is to keep paragraphs to three sentences or left when writing for online viewing.
ms42Q
force-pushed
the
improve-documentation
branch
from
7a60eed
to
4782a3e
Compare
|
Thanks for your review @oddlittlebird ! I applied your suggestions and rebased |
|
Thanks for contributing to the Loki docs! |
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.
What this PR does / why we need it:
Minor fix in the docs