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

[DOC] Change navigation for better usability #5227

Merged
merged 9 commits into from
Oct 17, 2023

Copy edits

688b24a
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

[DOC] Change navigation for better usability #5227

Copy edits
688b24a
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Oct 17, 2023 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (1)

_dashboards/dql.md|10 col 3| [OpenSearch.HeadingCapitalization] 'DQL' is a heading and should be in sentence case.

Filtered Findings (3504)

_data-prepper/managing-data-prepper/managing-data-prepper.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Managing Data Prepper' is a heading and should be in sentence case.
breaking-changes.md|22 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
breaking-changes.md|30 col 4| [OpenSearch.Inclusive] Use 'allow list' instead of 'Whitelist' because the latter is an offensive term.
breaking-changes.md|31 col 4| [OpenSearch.Inclusive] Use 'deny list' instead of 'Blacklist' because the latter is an offensive term.
breaking-changes.md|32 col 4| [OpenSearch.Inclusive] Use 'cluster manager' instead of 'Master' because the latter is an offensive term.
breaking-changes.md|34 col 5| [OpenSearch.HeadingCapitalization] 'Add OpenSearch Notifications plugins' is a heading and should be in sentence case.
breaking-changes.md|39 col 5| [OpenSearch.HeadingCapitalization] 'Drop support for JDK 8' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/monitoring.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Monitoring Data Prepper with metrics' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/monitoring.md|12 col 4| [OpenSearch.HeadingCapitalization] 'JVM and system metrics' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/monitoring.md|14 col 118| [OpenSearch.Spelling] Error: classloaders. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/monitoring.md|35 col 7| [OpenSearch.Spelling] Error: Gaugefir. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/monitoring.md|37 col 107| [OpenSearch.Spelling] Error: downstreams. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/monitoring.md|40 col 59| [OpenSearch.Spelling] Error: checkpointing. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/monitoring.md|55 col 99| [OpenSearch.Spelling] Error: recordsIn. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/monitoring.md|55 col 128| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_data-prepper/managing-data-prepper/core-apis.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Core APIs' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/core-apis.md|16 col 4| [OpenSearch.HeadingCapitalization] 'APIs' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/core-apis.md|24 col 181| [OpenSearch.HeadingCapitalization] 'SSL/TLS connection' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/core-apis.md|60 col 6| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/migrate-open-distro.md|7 col 3| [OpenSearch.HeadingCapitalization] 'Migrating from Open Distro' is a heading and should be in sentence case.
_data-prepper/migrate-open-distro.md|15 col 98| [Vale.Terms] Use 'Elasticsearch' instead of 'ElasticSearch'.
_data-prepper/getting-started.md|9 col 3| [OpenSearch.HeadingCapitalization] 'Getting started with Data Prepper' is a heading and should be in sentence case.
_data-prepper/getting-started.md|16 col 4| [OpenSearch.HeadingCapitalization] '1. Installing Data Prepper' is a heading and should be in sentence case.
_data-prepper/getting-started.md|29 col 4| [OpenSearch.HeadingCapitalization] '2. Configuring Data Prepper' is a heading and should be in sentence case.
_data-prepper/getting-started.md|83 col 4| [OpenSearch.HeadingCapitalization] '4. Running Data Prepper' is a heading and should be in sentence case.
_data-prepper/getting-started.md|95 col 36| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_data-prepper/getting-started.md|156 col 1| [OpenSearch.SubstitutionsError] Use 'for information about' instead of 'For information on'.
_data-prepper/managing-data-prepper/source-coordination.md|10 col 173| [OpenSearch.Spelling] Error: Kinesis. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/source-coordination.md|14 col 18| [OpenSearch.Spelling] Error: Kinesis. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/source-coordination.md|64 col 6| [OpenSearch.HeadingCapitalization] 'DynamoDB store' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/source-coordination.md|117 col 6| [OpenSearch.HeadingCapitalization] 'In-memory store (default)' is a heading and should be in sentence case.
_data-prepper/migrating-from-logstash-data-prepper.md|29 col 4| [OpenSearch.HeadingCapitalization] 'Running Data Prepper with a Logstash configuration' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|11 col 3| [OpenSearch.HeadingCapitalization] 'Configuring Data Prepper' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|16 col 4| [OpenSearch.HeadingCapitalization] 'Data Prepper configuration' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|22 col 1| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|26 col 1| [OpenSearch.Spelling] Error: serverPort. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|27 col 1| [OpenSearch.Spelling] Error: metricRegistries. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|28 col 1| [OpenSearch.Spelling] Error: metricTags. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|28 col 422| [OpenSearch.DirectionAboveBelow] Use 'previous, preceding, or earlier' instead of 'above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|30 col 138| [OpenSearch.UnitsSpacing] Put a space between the number and the units in '30s.'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|31 col 128| [OpenSearch.UnitsSpacing] Put a space between the number and the units in '30s.'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|32 col 32| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|32 col 68| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|35 col 5| [OpenSearch.HeadingCapitalization] 'Peer forwarder options' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|35 col 5| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|37 col 65| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|44 col 62| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|45 col 72| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|46 col 72| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|47 col 86| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|51 col 194| [OpenSearch.Spelling] Error: dns. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|55 col 186| [OpenSearch.Spelling] Error: num. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|55 col 234| [OpenSearch.Spelling] Error: Checkpointing. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|57 col 153| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|58 col 55| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|60 col 6| [OpenSearch.HeadingCapitalization] 'TLS/SSL options for peer forwarder' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|60 col 26| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|75 col 6| [OpenSearch.HeadingCapitalization] 'Authentication options for peer forwarder' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/configuring-data-prepper.md|75 col 33| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|8 col 3| [OpenSearch.HeadingCapitalization] 'Peer forwarder' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/peer-forwarder.md|8 col 3| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|10 col 1| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|12 col 1| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|12 col 366| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|30 col 5| [OpenSearch.HeadingCapitalization] 'DNS lookup' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/peer-forwarder.md|40 col 5| [OpenSearch.HeadingCapitalization] 'AWS Cloud Map' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/peer-forwarder.md|44 col 1| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|69 col 5| [OpenSearch.HeadingCapitalization] 'IAM policy with necessary permissions' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/peer-forwarder.md|95 col 84| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|96 col 97| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|97 col 82| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|98 col 82| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|99 col 95| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|106 col 265| [OpenSearch.Spelling] Error: Checkpointing. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/managing-data-prepper/peer-forwarder.md|109 col 68| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|111 col 4| [OpenSearch.HeadingCapitalization] 'SSL configuration' is a heading and should be in sentence case.
_data-prepper/managing-data-prepper/peer-forwarder.md|113 col 113| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|151 col 6| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|155 col 1| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|157 col 77| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|158 col 77| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|169 col 101| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|170 col 103| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/managing-data-prepper/peer-forwarder.md|171 col 86| [OpenSearch.Spelling] Error: unprocessable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/index.md|14 col 3| [OpenSearch.HeadingCapitalization] 'Data Prepper' is a heading and should be in sentence case.
_data-prepper/index.md|35 col 277| [Vale.Terms] Use 'OTel' instead of 'OTeL'.
_data-prepper/common-use-cases/s3-logs.md|54 col 48| [OpenSearch.AcronymParentheses] 'IAM': Spell out acronyms the first time that you use them on a page and follow them with the acronym in parentheses. Subsequently, use the acronym alone.
_data-prepper/common-use-cases/s3-logs.md|58 col 5| [OpenSearch.HeadingCapitalization] 'Setting permissions for Data Prepper' is a heading and should be in sentence case.
_data-prepper/common-use-cases/s3-logs.md|94 col 5| [OpenSearch.HeadingCapitalization] 'SQS dead-letter queue' is a heading and should be in sentence case.
_data-prepper/common-use-cases/s3-logs.md|103 col 128| [OpenSearch.Spelling] Error: dlq. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/s3-logs.md|108 col 19| [OpenSearch.Spelling] Error: SQS's. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/s3-logs.md|108 col 25| [OpenSearch.Spelling] Error: redrive. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/s3-logs.md|168 col 4| [OpenSearch.HeadingCapitalization] 'Multiple Data Prepper pipelines' is a heading and should be in sentence case.
_data-prepper/common-use-cases/s3-logs.md|174 col 4| [OpenSearch.HeadingCapitalization] 'Amazon SNS fanout pattern' is a heading and should be in sentence case.
_data-prepper/common-use-cases/s3-logs.md|174 col 15| [OpenSearch.Spelling] Error: fanout. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/s3-logs.md|176 col 264| [OpenSearch.Spelling] Error: fanout. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/log-analytics.md|16 col 271| [OpenSearch.Spelling] Error: http. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/log-analytics.md|24 col 5| [OpenSearch.HeadingCapitalization] 'HTTP source' is a heading and should be in sentence case.
_data-prepper/common-use-cases/log-analytics.md|30 col 14| [OpenSearch.DirectionAboveBelow] Use 'later' instead of '1.2 and above' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.
_data-prepper/common-use-cases/log-analytics.md|30 col 288| [OpenSearch.Spelling] Error: queryable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/log-analytics.md|32 col 208| [OpenSearch.Spelling] Error: syslogs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/log-analytics.md|44 col 5| [OpenSearch.HeadingCapitalization] 'Example pipeline with SSL and basic authentication enabled' is a heading and should be in sentence case.
_data-prepper/common-use-cases/log-analytics.md|93 col 4| [OpenSearch.HeadingCapitalization] 'Fluent Bit' is a heading and should be in sentence case.
_data-prepper/common-use-cases/log-analytics.md|95 col 256| [OpenSearch.Spelling] Error: http. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/log-analytics.md|99 col 5| [OpenSearch.HeadingCapitalization] 'Example: Fluent Bit file without SSL and basic authentication enabled' is a heading and should be in sentence case.
_data-prepper/common-use-cases/log-analytics.md|121 col 5| [OpenSearch.HeadingCapitalization] 'Example: Fluent Bit file with SSL and basic authentication enabled' is a heading and should be in sentence case.
_data-prepper/common-use-cases/log-analytics.md|152 col 150| [OpenSearch.Please] Using 'please' is unnecessary. Remove.
_data-prepper/pipelines/dlq.md|14 col 4| [OpenSearch.HeadingCapitalization] 'Configure a DLQ writer' is a heading and should be in sentence case.
_data-prepper/pipelines/dlq.md|74 col 4| [OpenSearch.HeadingCapitalization] 'DLQ objects' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/otel-metrics-source.md|18 col 76| [OpenSearch.Spelling] Error: Protobuf. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-metrics-source.md|22 col 1| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-metrics-source.md|27 col 1| [OpenSearch.Spelling] Error: awsRegion. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-trace.md|3 col 26| [OpenSearch.HeadingCapitalization] 'source' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/otel-trace.md|12 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_data-prepper/pipelines/configuration/sources/otel-trace.md|23 col 76| [OpenSearch.Spelling] Error: Protobuf. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-trace.md|27 col 1| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-trace.md|32 col 1| [OpenSearch.Spelling] Error: awsRegion. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-trace.md|38 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_data-prepper/pipelines/configuration/sources/http-source.md|23 col 1| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/expression-syntax.md|36 col 6| [OpenSearch.HeadingCapitalization] 'HTTP status codes' is a heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|42 col 6| [OpenSearch.HeadingCapitalization] 'HTTP response payloads' is a heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|99 col 4| [OpenSearch.HeadingCapitalization] 'Using equality operators to check for a JSON Pointer' is a heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|166 col 18| [OpenSearch.Spelling] Error: hardcoded. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/expression-syntax.md|168 col 5| [OpenSearch.HeadingCapitalization] 'JSON Pointer' is a heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|196 col 6| [OpenSearch.HeadingCapitalization] 'Example of an escaped JSON Pointer' is a heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|211 col 76| [OpenSearch.TableHeadings] '✅ Valid examples' is a table heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|211 col 141| [OpenSearch.TableHeadings] '❌ Invalid examples' is a table heading and should be in sentence case.
_data-prepper/pipelines/expression-syntax.md|217 col 41| [OpenSearch.Spelling] Error: pperators. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/expression-syntax.md|218 col 105| [OpenSearch.Spelling] Error: _code. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/kafka.md|9 col 3| [OpenSearch.HeadingCapitalization] 'kafka' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/kafka.md|9 col 3| [OpenSearch.Spelling] Error: kafka. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/kafka.md|95 col 5| [OpenSearch.HeadingCapitalization] 'SASL' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/kafka.md|107 col 6| [OpenSearch.HeadingCapitalization] 'SASL PLAINTEXT' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/kafka.md|126 col 6| [OpenSearch.HeadingCapitalization] 'AWS' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/kafka.md|132 col 138| [OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/kafka.md|136 col 6| [OpenSearch.HeadingCapitalization] 'MSK' is a heading and should be in sentence case.
_data-prepper/common-use-cases/trace-analytics.md|18 col 119| [OpenSearch.Spelling] Error: analyticis. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/trace-analytics.md|22 col 54| [OpenSearch.Spelling] Error: daemonset. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/common-use-cases/trace-analytics.md|35 col 105| [Vale.Terms] Use 'OTel' instead of 'otel'.
_data-prepper/common-use-cases/trace-analytics.md|41 col 4| [Vale.Terms] Use 'OTel' instead of 'otel'.
_data-prepper/common-use-cases/trace-analytics.md|59 col 47| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/common-use-cases/trace-analytics.md|92 col 5| [OpenSearch.HeadingCapitalization] 'AWS CloudFormation template and Kubernetes/Amazon EKS configuration files' is a heading and should be in sentence case.
_data-prepper/common-use-cases/trace-analytics.md|323 col 4| [OpenSearch.HeadingCapitalization] 'OpenTelemetry Collector' is a heading and should be in sentence case.
_data-prepper/common-use-cases/trace-analytics.md|325 col 197| [OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'collector. Ensure'.
_data-prepper/common-use-cases/trace-analytics.md|327 col 13| [Vale.Terms] Use 'OTel' instead of 'otel'.
_data-prepper/common-use-cases/trace-analytics.md|368 col 4| [OpenSearch.HeadingCapitalization] 'Migrating to Data Prepper 2.0' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/otel-logs-source.md|27 col 73| [OpenSearch.Spelling] Error: Protobuf. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-logs-source.md|32 col 5| [OpenSearch.HeadingCapitalization] 'SSL' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/otel-logs-source.md|38 col 3| [OpenSearch.Spelling] Error: ssl. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/otel-logs-source.md|43 col 3| [OpenSearch.Spelling] Error: awsRegion. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/pipeline.md|9 col 3| [OpenSearch.HeadingCapitalization] 'pipeline' is a heading and should be in sentence case.
_data-prepper/pipelines/pipelines.md|42 col 75| [OpenSearch.LatinismsElimination] Using 'etc.' is unnecessary. Remove.
_data-prepper/pipelines/pipelines.md|273 col 82| [OpenSearch.Simple] Don't use 'Simply' because it's not neutral in tone. If you mean 'only', use 'only' instead.
_data-prepper/pipelines/pipelines.md|273 col 97| [Vale.Terms] Use 'Logstash' instead of 'logstash'.
_data-prepper/pipelines/pipelines.md|273 col 97| [OpenSearch.Spelling] Error: logstash. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/pipelines.md|288 col 4| [OpenSearch.HeadingCapitalization] 'Configure the Data Prepper server' is a heading and should be in sentence case.
_data-prepper/pipelines/pipelines.md|290 col 323| [Vale.Terms] Use 'Docker' instead of 'docker'.
_data-prepper/pipelines/pipelines.md|300 col 76| [OpenSearch.Spelling] Error: yaml. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/pipelines.md|309 col 4| [OpenSearch.HeadingCapitalization] 'Configure peer forwarder' is a heading and should be in sentence case.
_data-prepper/pipelines/pipelines.md|309 col 14| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/pipelines/pipelines.md|311 col 285| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/pipelines/pipelines.md|313 col 1| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/pipelines/pipelines.md|313 col 189| [Vale.Terms] Use 'Peer Forwarder' instead of 'Peer forwarder'.
_data-prepper/pipelines/pipelines.md|315 col 14| [Vale.Terms] Use 'Peer Forwarder' instead of 'peer forwarder'.
_data-prepper/pipelines/configuration/sinks/file.md|9 col 3| [OpenSearch.HeadingCapitalization] 'file' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/buffers/bounded-blocking.md|11 col 1| [OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
_data-prepper/pipelines/configuration/processors/date.md|9 col 3| [OpenSearch.HeadingCapitalization] 'date' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/processors/date.md|21 col 50| [Vale.Terms] Use 'Boolean' instead of 'boolean'.
_data-prepper/pipelines/configuration/processors/date.md|21 col 50| [OpenSearch.Spelling] Error: boolean. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/processors/date.md|23 col 188| [OpenSearch.SubstitutionsError] Use 'time zone' instead of 'timezone'.
_data-prepper/pipelines/configuration/processors/date.md|24 col 38| [OpenSearch.SubstitutionsError] Use 'time zone' instead of 'Timezone'.
_data-prepper/pipelines/configuration/processors/date.md|24 col 112| [OpenSearch.SubstitutionsError] Use 'time zone' instead of 'timezone'.
_data-prepper/pipelines/configuration/sources/opensearch.md|9 col 3| [OpenSearch.Spelling] Error: opensearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/opensearch.md|9 col 3| [Vale.Terms] Use 'OpenSearch' instead of 'opensearch'.
_data-prepper/pipelines/configuration/sources/opensearch.md|9 col 3| [OpenSearch.HeadingCapitalization] 'opensearch' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/opensearch.md|106 col 166| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'Indices'.
_data-prepper/pipelines/configuration/sources/opensearch.md|125 col 5| [OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
_data-prepper/pipelines/configuration/sources/opensearch.md|125 col 5| [OpenSearch.HeadingCapitalization] 'indices' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/opensearch.md|167 col 5| [OpenSearch.HeadingCapitalization] 'AWS' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sources/opensearch.md|173 col 139| [OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sources/opensearch.md|243 col 5| [OpenSearch.HeadingCapitalization] 'OpenSearch Serverless collection security' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/processors/convert_entry_type.md|38 col 128| [OpenSearch.Spelling] Error: filepath. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|9 col 3| [OpenSearch.HeadingCapitalization] 's3' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sinks/s3.md|48 col 2| [OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|48 col 49| [OpenSearch.HeadingCapitalization] 'aws' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sinks/s3.md|48 col 49| [OpenSearch.Spelling] Error: aws. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|91 col 4| [OpenSearch.HeadingCapitalization] 'codec' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sinks/s3.md|95 col 5| [OpenSearch.Spelling] Error: avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|95 col 5| [OpenSearch.HeadingCapitalization] 'avro codec' is a heading and should be in sentence case.
_data-prepper/pipelines/configuration/sinks/s3.md|97 col 48| [OpenSearch.Spelling] Error: Avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|99 col 9| [OpenSearch.Spelling] Error: Avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|102 col 33| [OpenSearch.Spelling] Error: Avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|104 col 28| [OpenSearch.Repetition] 'each' is repeated.
_data-prepper/pipelines/configuration/sinks/s3.md|106 col 27| [OpenSearch.Spelling] Error: Avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|114 col 49| [OpenSearch.Spelling] Error: nullable. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
_data-prepper/pipelines/configuration/sinks/s3.md|120 col 31| [OpenSearch.Spelling] Error: Avro. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Annotations

Check failure on line 10 in _dashboards/dql.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] _dashboards/dql.md#L10

[OpenSearch.HeadingCapitalization] 'DQL' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'DQL' is a heading and should be in sentence case.", "location": {"path": "_dashboards/dql.md", "range": {"start": {"line": 10, "column": 3}}}, "severity": "ERROR"}