From 2d7a92aded05465c00a2b61501cccaf8e037f82b Mon Sep 17 00:00:00 2001 From: Bill Easton Date: Tue, 24 Mar 2026 14:34:45 -0500 Subject: [PATCH] docs: fix grammar errors in user-facing reference documentation (#49638) (cherry picked from commit c262cc2aafc07b32f2c6a7d281f3fa8ba6aef96a) --- changelog/fragments/1774377466-fix-typos-docs-ingest.yaml | 3 +++ docs/reference/auditbeat/configuration-dashboards.md | 2 +- docs/reference/auditbeat/syslog.md | 2 +- docs/reference/filebeat/configuration-dashboards.md | 2 +- docs/reference/filebeat/filebeat-input-winlog.md | 2 +- docs/reference/filebeat/syslog.md | 2 +- docs/reference/heartbeat/syslog.md | 2 +- docs/reference/metricbeat/configuration-dashboards.md | 2 +- docs/reference/metricbeat/syslog.md | 2 +- docs/reference/packetbeat/configuration-dashboards.md | 2 +- docs/reference/packetbeat/syslog.md | 2 +- docs/reference/winlogbeat/command-line-options.md | 2 +- docs/reference/winlogbeat/configuration-dashboards.md | 2 +- docs/reference/winlogbeat/configuration-winlogbeat-options.md | 2 +- docs/reference/winlogbeat/syslog.md | 2 +- 15 files changed, 17 insertions(+), 14 deletions(-) create mode 100644 changelog/fragments/1774377466-fix-typos-docs-ingest.yaml diff --git a/changelog/fragments/1774377466-fix-typos-docs-ingest.yaml b/changelog/fragments/1774377466-fix-typos-docs-ingest.yaml new file mode 100644 index 000000000000..98bc9b3d055d --- /dev/null +++ b/changelog/fragments/1774377466-fix-typos-docs-ingest.yaml @@ -0,0 +1,3 @@ +kind: bug-fix +summary: Fix grammar errors in user-facing reference docs (dashboard agreement, pipelines spelling, settings agreement, configuring usage) +component: all diff --git a/docs/reference/auditbeat/configuration-dashboards.md b/docs/reference/auditbeat/configuration-dashboards.md index 3595b88ed228..cfa240cd9944 100644 --- a/docs/reference/auditbeat/configuration-dashboards.md +++ b/docs/reference/auditbeat/configuration-dashboards.md @@ -42,7 +42,7 @@ When dashboard loading is enabled, Auditbeat overwrites any existing dashboards :::: -If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Auditbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). +If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Auditbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). ### `setup.dashboards.directory` [directory-option] diff --git a/docs/reference/auditbeat/syslog.md b/docs/reference/auditbeat/syslog.md index e7faf1b08bd3..dfd19d9f9041 100644 --- a/docs/reference/auditbeat/syslog.md +++ b/docs/reference/auditbeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/auditbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/auditbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: diff --git a/docs/reference/filebeat/configuration-dashboards.md b/docs/reference/filebeat/configuration-dashboards.md index c28295c534f8..601ff6d76ac5 100644 --- a/docs/reference/filebeat/configuration-dashboards.md +++ b/docs/reference/filebeat/configuration-dashboards.md @@ -42,7 +42,7 @@ When dashboard loading is enabled, Filebeat overwrites any existing dashboards t :::: -If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Filebeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). +If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Filebeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). ### `setup.dashboards.directory` [directory-option] diff --git a/docs/reference/filebeat/filebeat-input-winlog.md b/docs/reference/filebeat/filebeat-input-winlog.md index e8ea68eca16a..5aea3d92e0d3 100644 --- a/docs/reference/filebeat/filebeat-input-winlog.md +++ b/docs/reference/filebeat/filebeat-input-winlog.md @@ -131,7 +131,7 @@ If this option is specified, the input filters events that are older than the sp A boolean flag to indicate that the log contains only events collected from remote hosts using the Windows Event Collector. The value defaults to true for the ForwardedEvents log and false for any other log. **{This option is only available on operating systems + supporting the Windows Event Log API (Microsoft Windows Vista and newer).}** -This settings allows Filebeat to optimize reads for forwarded events that are already rendered. When the value is true Filebeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions. +This setting allows Filebeat to optimize reads for forwarded events that are already rendered. When the value is true Filebeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions. ### `event_id` [_event_id] diff --git a/docs/reference/filebeat/syslog.md b/docs/reference/filebeat/syslog.md index 9ad6c5d1e3fc..543e278eb6ca 100644 --- a/docs/reference/filebeat/syslog.md +++ b/docs/reference/filebeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics_19] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/filebeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/filebeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: diff --git a/docs/reference/heartbeat/syslog.md b/docs/reference/heartbeat/syslog.md index 97d733d7f6c3..b5cbd705afbb 100644 --- a/docs/reference/heartbeat/syslog.md +++ b/docs/reference/heartbeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/heartbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/heartbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: diff --git a/docs/reference/metricbeat/configuration-dashboards.md b/docs/reference/metricbeat/configuration-dashboards.md index 6905e164ae9a..49af9112f23f 100644 --- a/docs/reference/metricbeat/configuration-dashboards.md +++ b/docs/reference/metricbeat/configuration-dashboards.md @@ -42,7 +42,7 @@ When dashboard loading is enabled, Metricbeat overwrites any existing dashboards :::: -If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Metricbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). +If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Metricbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). ### `setup.dashboards.directory` [directory-option] diff --git a/docs/reference/metricbeat/syslog.md b/docs/reference/metricbeat/syslog.md index dc7cb01be043..dd793a4391fe 100644 --- a/docs/reference/metricbeat/syslog.md +++ b/docs/reference/metricbeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/metricbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/metricbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: diff --git a/docs/reference/packetbeat/configuration-dashboards.md b/docs/reference/packetbeat/configuration-dashboards.md index f2d0207c96e6..6818ea30def7 100644 --- a/docs/reference/packetbeat/configuration-dashboards.md +++ b/docs/reference/packetbeat/configuration-dashboards.md @@ -42,7 +42,7 @@ When dashboard loading is enabled, Packetbeat overwrites any existing dashboards :::: -If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Packetbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). +If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Packetbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). ### `setup.dashboards.directory` [directory-option] diff --git a/docs/reference/packetbeat/syslog.md b/docs/reference/packetbeat/syslog.md index 2e9e27f998d7..13962e397714 100644 --- a/docs/reference/packetbeat/syslog.md +++ b/docs/reference/packetbeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/packetbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/packetbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: diff --git a/docs/reference/winlogbeat/command-line-options.md b/docs/reference/winlogbeat/command-line-options.md index 38f680faa87f..6603fa554430 100644 --- a/docs/reference/winlogbeat/command-line-options.md +++ b/docs/reference/winlogbeat/command-line-options.md @@ -68,7 +68,7 @@ $$$ilm-policy-subcommand$$$ $$$pipeline-subcommand$$$ **`pipeline`** -: Exports the ingest piplines. You must specify the `--es.version` to specify which version of {{es}} the pipelines should be compatible with. You can optionally specify `--dir` to control where the pipelines are written. +: Exports the ingest pipelines. You must specify the `--es.version` to specify which version of {{es}} the pipelines should be compatible with. You can optionally specify `--dir` to control where the pipelines are written. **FLAGS** diff --git a/docs/reference/winlogbeat/configuration-dashboards.md b/docs/reference/winlogbeat/configuration-dashboards.md index bdbc83fde69a..964d4c9ac6cc 100644 --- a/docs/reference/winlogbeat/configuration-dashboards.md +++ b/docs/reference/winlogbeat/configuration-dashboards.md @@ -42,7 +42,7 @@ When dashboard loading is enabled, Winlogbeat overwrites any existing dashboards :::: -If no other options are set, the dashboard are loaded from the local `kibana` directory in the home path of the Winlogbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). +If no other options are set, the dashboards are loaded from the local `kibana` directory in the home path of the Winlogbeat installation. To load dashboards from a different location, you can configure one of the following options: [`setup.dashboards.directory`](#directory-option), [`setup.dashboards.url`](#url-option), or [`setup.dashboards.file`](#file-option). ### `setup.dashboards.directory` [directory-option] diff --git a/docs/reference/winlogbeat/configuration-winlogbeat-options.md b/docs/reference/winlogbeat/configuration-winlogbeat-options.md index 1991b6a40e78..40f9c6ef7f29 100644 --- a/docs/reference/winlogbeat/configuration-winlogbeat-options.md +++ b/docs/reference/winlogbeat/configuration-winlogbeat-options.md @@ -174,7 +174,7 @@ winlogbeat.event_logs: A boolean flag to indicate that the log contains only events collected from remote hosts using the Windows Event Collector. The value defaults to true for the ForwardedEvents log and false for any other log. **This option is only available on operating systems supporting the Windows Event Log API (Microsoft Windows Vista and newer).** -This settings allows Winlogbeat to optimize reads for forwarded events that are already rendered. When the value is true Winlogbeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions. +This setting allows Winlogbeat to optimize reads for forwarded events that are already rendered. When the value is true Winlogbeat does not attempt to render the event using message files from the host computer. The Windows Event Collector subscription should be configured to use the "RenderedText" format (this is the default) to ensure that the events are distributed with messages and descriptions. ### `event_logs.event_id` [_event_logs_event_id] diff --git a/docs/reference/winlogbeat/syslog.md b/docs/reference/winlogbeat/syslog.md index 1aeb9a40d1d5..fde973143e88 100644 --- a/docs/reference/winlogbeat/syslog.md +++ b/docs/reference/winlogbeat/syslog.md @@ -130,7 +130,7 @@ For RFC 5424-formatted logs, if the structured data cannot be parsed according t ## Metrics [_metrics] -Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/winlogbeat/http-endpoint.md) for more information on configuration the metrics HTTP endpoint. +Internal metrics are available to assist with debugging efforts. The metrics are served from the metrics HTTP endpoint (for example: `http://localhost:5066/stats`) and are found under `processor.syslog.[instance ID]` or `processor.syslog.[tag]-[instance ID]` if a **tag** is provided. See [HTTP endpoint](/reference/winlogbeat/http-endpoint.md) for more information on configuring the metrics HTTP endpoint. For example, here are metrics from a processor with a **tag** of `log-input` and an **instance ID** of `1`: