Skip to content

Commit 0bc4a62

Browse files
Lint all docs for spelling (#1851)
* lint for spelling in docs/en/observability/ * lint for spelling in docs/en/ingest-management/ * lint for spelling in docs/en/integrations/ * lint for spelling in docs/en/shared/ * lint for spelling in docs/en/templates/ * clean up more clean up clean up again * address recent commits from main catch up again * clean up one more clean up * address first round of feedback from @dedemorton * environmental to environment * address adjusted overrides * more edits * remove extra backtick
1 parent facb75f commit 0bc4a62

File tree

99 files changed

+270
-247
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+270
-247
lines changed

docs/en/ingest-management/beats-agent-comparison.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ configure output queue parameters to tune your environment, and the Agent takes
169169
care of configuring the internal queues to accomplish your tuning intent.
170170

171171
|{filebeat-ref}/load-balancing.html[Load balance output hosts]
172-
|Within the {fleet} UI, you can add yaml settings to configure multiple hosts
173-
per output type, which enables loadbalancing.
172+
|Within the {fleet} UI, you can add YAML settings to configure multiple hosts
173+
per output type, which enables load balancing.
174174

175175
|{filebeat-ref}/configuration-logging.html[Logging]
176176
|Supported

docs/en/ingest-management/commands.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Gather diagnostics information from the {agent} and applications it's running.
3636

3737
If no options are specified, this command displays version numbers and application metadata.
3838

39-
If `collect` is specified, it produces an archive containing application metadata, configuration information, the policy, local logs, and metics data (if the buffer is enabled).
39+
If `collect` is specified, it produces an archive containing application metadata, configuration information, the policy, local logs, and metrics data (if the buffer is enabled).
4040

4141
Note that *credentials are not redacted* in the archive; they may appear in plain text in the configuration or policy files inside the archive.
4242

4343
This command is intended for debugging purposes only. The output format and structure of the archive produced by `collect` may change between releases.
4444

4545
If `pprof` is specified, it gathers specific `pprof` data from the {agent} or one of the specified underlying {beats}, and displays to `stdout`.
46-
By default it gathers a 30s profile of the {agent}.
46+
By default it gathers a 30 second profile of the {agent}.
4747

4848
[discrete]
4949
=== Synopsis
@@ -93,7 +93,7 @@ Should be longer then `pprof-duration` as the command needs to gather and proces
9393
Must be a string that can be parsed as a `time.Duration` value (default: `30s + pprof-duration`).
9494

9595
`--pprof-type <string>`::
96-
The pprof data to gather, one of: `allocs`, `block`, `cmdline`, `goroutine`, `heap`, `mutex`, `profile`, `threadcreate`, or `trace` (default: `profile`).
96+
The `pprof` data to gather, one of: `allocs`, `block`, `cmdline`, `goroutine`, `heap`, `mutex`, `profile`, `threadcreate`, or `trace` (default: `profile`).
9797

9898
`--pprof-application <string>`::
9999
The application name to gather `pprof` data from (default `elastic-agent`).
@@ -239,7 +239,7 @@ specified {es} URL.
239239
Path to certificate authority to use to communicate with {es}.
240240

241241
`--fleet-server-es-ca-trusted-fingerprint <string>`::
242-
The SHA2-56 fingerprint (hash) of the certificate authority used to self-sign {es} certificates.
242+
The SHA-256 fingerprint (hash) of the certificate authority used to self-sign {es} certificates.
243243
This fingerprint will be used to verify self-signed certificates presented by {fleet-server} and any inputs started by {agent} for communication.
244244
This flag is required when using self-signed certificates with {es}.
245245

docs/en/ingest-management/data-streams.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ data–meaning no more indices with hundreds of thousands of fields.
1111
This leads to better space efficiency and faster queries.
1212
As an added bonus, only relevant fields are shown in Discover.
1313

14-
* *More granular data control*: For example, filesystem, load, cpu, network, and process metrics are sent
14+
* *More granular data control*: For example, file system, load, CPU, network, and process metrics are sent
1515
to different indices–each potentially with its own rollover, retention, and security permissions.
1616

1717
* *Flexible*: Use the custom namespace component to divide and organize data in a way that
@@ -233,7 +233,7 @@ The result should include the following:
233233
<2> The name of the {ilm-init} policy applied to the new component template in step two
234234

235235
New {ilm-init} policies only take effect when new indices are created,
236-
so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50GB),
236+
so you either must wait for a rollover to occur (usually after 30 days or when the index size reaches 50 GB),
237237
or force a rollover using the {ref}/indices-rollover-index.html[{es} rollover API]:
238238

239239
[source,bash]

docs/en/ingest-management/elastic-agent/configuration/authentication/ssl-shared-settings.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ chains.
4848
|
4949
[id="{type}-ssl.cipher_suites-common-setting"]
5050
`ssl.cipher_suites`
51-
51+
// lint ignore crypto
5252
| (list) The list of cipher suites to use. The first entry has the highest
5353
priority. If this option is omitted, the Go crypto library's
5454
https://golang.org/pkg/crypto/tls/[default suites] are used (recommended). Note
@@ -57,6 +57,7 @@ not included in this list.
5757

5858
The following cipher suites are available:
5959

60+
// lint ignore
6061
* ECDHE-ECDSA-AES-128-CBC-SHA
6162
* ECDHE-ECDSA-AES-128-CBC-SHA256: TLS 1.2 only. Disabled by default.
6263
* ECDHE-ECDSA-AES-128-GCM-SHA256: TLS 1.2 only.

docs/en/ingest-management/elastic-agent/configuration/env/shared-env.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// These env variables are shared across the docs. Copy and use
1+
// These environment variables are shared across the docs. Copy and use
22
// the following template to add a shared setting. Replace values in all caps.
33
// Use an include statement // to pull the tagged region into your source file:
44
// include::input-shared-settings.asciidoc[tag=NAME-setting]

docs/en/ingest-management/elastic-agent/configuration/inputs/input-configuration.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ include::{fleet-repo-dir}/standalone-note.asciidoc[]
1010
The `inputs` section of the `elastic-agent.yml` file specifies how {agent}
1111
locates and processes input data.
1212

13-
By default {agent} collects system metrics, such as cpu, memory, network, and
14-
filesystem metrics, and sends them to the default output. For example:
13+
By default {agent} collects system metrics, such as CPU, memory, network, and
14+
file system metrics, and sends them to the default output. For example:
1515

1616
[source,yaml]
1717
-------------------------------------------------------------------------------------

docs/en/ingest-management/elastic-agent/configuration/outputs/output-elasticsearch.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ include::../authentication/ssl-shared-settings.asciidoc[tag=ssl-all-settings]
256256

257257
The following encryption types are supported:
258258

259+
// lint ignore
259260
* aes128-cts-hmac-sha1-96
260261
* aes128-cts-hmac-sha256-128
261262
* aes256-cts-hmac-sha1-96
@@ -452,7 +453,7 @@ a comma.
452453
[id="{type}-parameters-setting"]
453454
`parameters`
454455

455-
| Dictionary of HTTP parameters to pass within the url with index operations.
456+
| Dictionary of HTTP parameters to pass within the URL with index operations.
456457
// end::parameters-setting[]
457458

458459
// =============================================================================

docs/en/ingest-management/elastic-agent/configuration/outputs/output-logstash.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ connection to achieve equal connection distribution across instances.
333333

334334
*Default:* `0` (turns off the feature)
335335

336-
NOTE: The `ttl` option is not yet supported on an async {ls} client (one with
336+
NOTE: The `ttl` option is not yet supported on an asynchronous {ls} client (one with
337337
the `pipelining` option set).
338338

339339
// end::ttl-setting[]

docs/en/ingest-management/elastic-agent/configuration/providers/docker-provider.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Provides inventory information from Docker. The available keys are:
55

6-
6+
// lint disable arg
77
|===
88
|Key |Type |Description
99

@@ -39,6 +39,7 @@ Provides inventory information from Docker. The available keys are:
3939
|`string`
4040
|Log path of the container
4141
|===
42+
// lint enable arg
4243

4344
For example, the Docker provider provides the following inventory:
4445

docs/en/ingest-management/elastic-agent/configuration/providers/elastic-agent-providers.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Context providers use the Elastic Common Schema (ECS) naming to ensure consisten
6161

6262
{agent} supports the following context providers:
6363

64+
// lint ignore env
6465
* <<local-provider,Local>>
6566
* <<agent-provider,Agent Provider>>
6667
* <<host-provider,Host Provider>>

0 commit comments

Comments
 (0)