Skip to content

Commit 75f5fa8

Browse files
[OnWeek] Fix Vale rule warnings in release-notes and reference (excl fleet) (#3906)
This PR is part of the OnWeek project about fixing Vale rule violations in docs-content. It fixes warnings in: - `release-notes` - `reference` (excluding the `fleet` folder) Assisted by Cursor.
1 parent 9badb42 commit 75f5fa8

File tree

14 files changed

+40
-40
lines changed

14 files changed

+40
-40
lines changed

reference/glossary/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $$$glossary-metadata$$$ @metadata
2020

2121
$$$glossary-action$$$ action
2222
: 1. The rule-specific response that occurs when an alerting rule fires. A rule can have multiple actions. See [Connectors and actions](kibana://reference/connectors-kibana.md).
23-
2. In {{elastic-sec}}, actions send notifications via other systems when a detection alert is created, such as email, Slack, PagerDuty, and {{webhook}}.
23+
2. In {{elastic-sec}}, actions send notifications through other systems when a detection alert is created, such as email, Slack, PagerDuty, and {{webhook}}.
2424

2525

2626
$$$glossary-admin-console$$$ administration console
@@ -281,7 +281,7 @@ $$$glossary-eql$$$ Event Query Language (EQL)
281281
: [Query](/reference/glossary/index.md#glossary-query) language for event-based time series data, such as logs, metrics, and traces. EQL supports matching for event sequences. See [EQL](/explore-analyze/query-filter/languages/eql.md).
282282

283283
$$$glossary-event$$$ event
284-
: A single unit of information, containing a timestamp plus additional data. An event arrives via an input, and is subsequently parsed, timestamped, and passed through the {{ls}} [pipeline](/reference/glossary/index.md#glossary-pipeline).
284+
: A single unit of information, containing a timestamp plus additional data. An event arrives through an input, and is subsequently parsed, timestamped, and passed through the {{ls}} [pipeline](/reference/glossary/index.md#glossary-pipeline).
285285

286286
$$$glossary-exception$$$ exception
287287
: In {{elastic-sec}}, exceptions are added to rules to prevent specific source event field values from generating alerts.
@@ -313,7 +313,7 @@ $$$glossary-field$$$ field
313313

314314

315315
$$$glossary-filter-plugin$$$ filter plugin
316-
: A {{ls}} [plugin](/reference/glossary/index.md#glossary-plugin) that performs intermediary processing on an [event](/reference/glossary/index.md#glossary-event). Typically, filters act upon event data after it has been ingested via inputs, by mutating, enriching, and/or modifying the data according to configuration rules. Filters are often applied conditionally depending on the characteristics of the event. Popular filter plugins include grok, mutate, drop, clone, and geoip. Filter stages are optional.
316+
: A {{ls}} [plugin](/reference/glossary/index.md#glossary-plugin) that performs intermediary processing on an [event](/reference/glossary/index.md#glossary-event). Typically, filters act upon event data after it has been ingested through inputs, by mutating, enriching, or modifying the data according to configuration rules. Filters are often applied conditionally depending on the characteristics of the event. Popular filter plugins include grok, mutate, drop, clone, and geoip. Filter stages are optional.
317317

318318
$$$glossary-filter$$$ filter
319319
: [Query](/reference/glossary/index.md#glossary-query) that does not score matching documents. See [filter context](/explore-analyze/query-filter/languages/querydsl.md).
@@ -453,7 +453,7 @@ $$$glossary-integration-policy$$$ integration policy
453453
: An instance of an [integration](/reference/glossary/index.md#glossary-integration) that is configured for a specific use case, such as collecting logs from a specific file.
454454

455455
$$$glossary-integration$$$ integration
456-
: An easy way for external systems to connect to the {{stack}}. Whether it's collecting data or protecting systems from security threats, integrations provide out-of-the-box assets to make setup easy—many with just a single click.
456+
: An easy way for external systems to connect to the {{stack}}. Whether it's collecting data or protecting systems from security threats, integrations provide out-of-the-box assets to make setup easy—many with only a single click.
457457

458458

459459
## J [j-glos]
@@ -582,7 +582,7 @@ $$$glossary-plan$$$ plan
582582
: Specifies the configuration and topology of an {{es}} or {{kib}} cluster, such as capacity, availability, and {{es}} version, for example. When changing a plan, the [constructor](/reference/glossary/index.md#glossary-constructor) determines how to transform the existing cluster into the pending plan.
583583

584584
$$$glossary-plugin-manager$$$ plugin manager
585-
: Accessed via the `bin/logstash-plugin` script, the plugin manager enables you to manage the lifecycle of [plugins](/reference/glossary/index.md#glossary-plugin) in your {{ls}} deployment. You can install, remove, and upgrade plugins by using the plugin manager Command Line Interface (CLI).
585+
: Accessed through the `bin/logstash-plugin` script, the plugin manager enables you to manage the lifecycle of [plugins](/reference/glossary/index.md#glossary-plugin) in your {{ls}} deployment. You can install, remove, and upgrade plugins by using the plugin manager Command Line Interface (CLI).
586586

587587
$$$glossary-plugin$$$ plugin
588588
: A self-contained software package that implements one of the stages in the {{ls}} event processing [pipeline](/reference/glossary/index.md#glossary-pipeline). The list of available plugins includes [input plugins](/reference/glossary/index.md#glossary-input-plugin), [output plugins](/reference/glossary/index.md#glossary-output-plugin), [codec plugins](/reference/glossary/index.md#glossary-codec-plugin), and [filter plugins](/reference/glossary/index.md#glossary-filter-plugin). The plugins are implemented as Ruby [gems](/reference/glossary/index.md#glossary-gem) and hosted on [RubyGems.org](https://rubygems.org). You define the stages of an event processing [pipeline](/reference/glossary/index.md#glossary-pipeline) by configuring plugins.
@@ -791,7 +791,7 @@ $$$glossary-upgrade-assistant$$$ Upgrade Assistant
791791
: A tool that helps you prepare for an upgrade to the next major version of {{es}}. The assistant identifies the deprecated settings in your cluster and indices and guides you through resolving issues, including reindexing. See [Upgrade Assistant](/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant.md).
792792

793793
$$$glossary-uptime$$$ Uptime
794-
: A metric of system reliability used to monitor the status of network endpoints via HTTP/S, TCP, and ICMP.
794+
: A metric of system reliability used to monitor the status of network endpoints through HTTP/S, TCP, and ICMP.
795795

796796

797797
## V [v-glos]
@@ -806,7 +806,7 @@ $$$glossary-vega$$$ Vega
806806
: A declarative language used to create interactive visualizations. See [Vega](/explore-analyze/dashboards.md).
807807

808808
$$$glossary-visualization$$$ visualization
809-
: A graphical representation of query results in {{kib}} (e.g., a histogram, line graph, pie chart, or heat map).
809+
: A graphical representation of query results in {{kib}} (for example, a histogram, line graph, pie chart, or heat map).
810810

811811

812812
## W [w-glos]

reference/machine-learning/ml-metric-functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ products:
77

88
# Metric functions [ml-metric-functions]
99

10-
The metric functions include functions such as mean, min and max. These values are calculated for each bucket. Field values that cannot be converted to double precision floating point numbers are ignored.
10+
The metric functions include functions such as mean, min, and max. These values are calculated for each bucket. Field values that cannot be converted to double precision floating point numbers are ignored.
1111

1212
The {{ml-features}} include the following metric functions:
1313

@@ -97,7 +97,7 @@ The `median` function detects anomalies in the statistical median of a value. Th
9797

9898
If you want to monitor unusually high median values, use the `high_median` function.
9999

100-
If you are just interested in unusually low median values, use the `low_median` function.
100+
If you are only interested in unusually low median values, use the `low_median` function.
101101

102102
These functions support the following properties:
103103

@@ -125,7 +125,7 @@ The `mean` function detects anomalies in the arithmetic mean of a value. The mea
125125

126126
If you want to monitor unusually high average values, use the `high_mean` function.
127127

128-
If you are just interested in unusually low average values, use the `low_mean` function.
128+
If you are only interested in unusually low average values, use the `low_mean` function.
129129

130130
These functions support the following properties:
131131

@@ -199,7 +199,7 @@ The `varp` function detects anomalies in the variance of a value which is a meas
199199

200200
If you want to monitor unusually high variance, use the `high_varp` function.
201201

202-
If you are just interested in unusually low variance, use the `low_varp` function.
202+
If you are only interested in unusually low variance, use the `low_varp` function.
203203

204204
These functions support the following properties:
205205

reference/machine-learning/ootb-ml-jobs-apache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ These {{anomaly-job}} wizards appear in {{kib}} if you use the Apache integratio
1414

1515
These {{anomaly-jobs}} find unusual activity in HTTP access logs.
1616

17-
For more details, see the {{dfeed}} and job definitions in [GitHub](https://github.com/elastic/integrations/blob/main/packages/apache/kibana/ml_module/apache-Logs-ml.json). Note that these jobs are available in {{kib}} only if data exists that matches the query specified in the [manifest file](https://github.com/elastic/integrations/blob/main/packages/apache/kibana/ml_module/apache-Logs-ml.json#L11).
17+
For more details, see the {{dfeed}} and job definitions in [GitHub](https://github.com/elastic/integrations/blob/main/packages/apache/kibana/ml_module/apache-Logs-ml.json). These jobs are available in {{kib}} only if data exists that matches the query specified in the [manifest file](https://github.com/elastic/integrations/blob/main/packages/apache/kibana/ml_module/apache-Logs-ml.json#L11).
1818

1919
| Name | Description | Job (JSON) | Datafeed |
2020
| --- | --- | --- | --- |

reference/machine-learning/ootb-ml-jobs-logs-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ These {{anomaly-jobs}} appear by default in the [{{logs-app}}](/solutions/observ
1212

1313
## Log analysis [logs-ui-analysis]
1414

15-
Detect anomalies in log entries via the Logs UI.
15+
Detect anomalies in log entries through the Logs UI.
1616

1717
| Name | Description | Job (JSON) | Datafeed |
1818
| --- | --- | --- | --- |

0 commit comments

Comments
 (0)