Skip to content

Commit a03adf6

Browse files
[OnWeek] Fix Vale rule violations in manage-data (#3869)
This PR is part of the OnWeek project about fixing Vale rule violations in docs-content. It fixes warnings and suggestions in the top-level `manage-data` files and the `manage-data/_snippets` subfolder. Assisted by Cursor.
1 parent 75f5fa8 commit a03adf6

File tree

9 files changed

+42
-42
lines changed

9 files changed

+42
-42
lines changed

manage-data/_snippets/ilm-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To restart {{ilm-init}} and resume executing policies, use the [{{ilm-init}} sta
66
POST _ilm/start
77
```
88

9-
The response will look like this:
9+
The response looks like this:
1010

1111
```console-result
1212
{
@@ -20,7 +20,7 @@ Verify that {{ilm}} is now running:
2020
GET _ilm/status
2121
```
2222

23-
The response will look like this:
23+
The response looks like this:
2424

2525
```console-result
2626
{

manage-data/_snippets/ilm-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To see the current status of the {{ilm-init}} service, use the [{{ilm-init}} status API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status):
1+
To view the current status of the {{ilm-init}} service, use the [{{ilm-init}} status API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status):
22

33
```console
44
GET _ilm/status

manage-data/_snippets/ilm-stop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ By default, the {{ilm}} service is in the `RUNNING` state and manages all indice
33
You can stop {{ilm-init}} to suspend management operations for all indices. For example, you might stop {{ilm}} when performing scheduled maintenance or making changes to the cluster that could impact the execution of {{ilm-init}} actions.
44

55
::::{important}
6-
When you stop {{ilm-init}}, [{{slm-init}}](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm) operations are also suspended. No snapshots will be taken as scheduled until you restart {{ilm-init}}. In-progress snapshots are not affected.
6+
When you stop {{ilm-init}}, [{{slm-init}}](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm) operations are also suspended. {{slm-init}} will not take snapshots as scheduled until you restart {{ilm-init}}. In-progress snapshots are not affected.
77
::::
88

99
To stop the {{ilm-init}} service and pause execution of all lifecycle policies, use the [{{ilm-init}} stop API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop):
@@ -12,7 +12,7 @@ To stop the {{ilm-init}} service and pause execution of all lifecycle policies,
1212
POST _ilm/stop
1313
```
1414

15-
The response will look like this:
15+
The response looks like this:
1616

1717
```console-result
1818
{
@@ -28,7 +28,7 @@ While the {{ilm-init}} service is shutting down, run the status API to verify th
2828
GET _ilm/status
2929
```
3030

31-
The response will look like this:
31+
The response looks like this:
3232

3333
```console-result
3434
{

manage-data/data-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ The documentation in this section details how {{es}} works as a _data store_ sta
1616

1717
Then, learn how these documents and the fields they contain are stored and indexed in [Mapping](/manage-data/data-store/mapping.md), and how unstructured text is converted into a structured format that’s optimized for search in [Text analysis](/manage-data/data-store/text-analysis.md).
1818

19-
You can also read more about working with {{es}} as a data store including how to use [index templates](/manage-data/data-store/templates.md) to tell {{es}} how to configure an index when it is created, how to use [aliases](/manage-data/data-store/aliases.md) to point to multiple indices, and how to use the [command line to manage data](/manage-data/data-store/manage-data-from-the-command-line.md) stored in {{es}}.
19+
You can also read more about working with {{es}} as a data store including how to use [index templates](/manage-data/data-store/templates.md) to tell {{es}} how to configure an index when you create it, how to use [aliases](/manage-data/data-store/aliases.md) to point to multiple indices, and how to use the [command line to manage data](/manage-data/data-store/manage-data-from-the-command-line.md) stored in {{es}}.
2020

21-
If your use case involves working with continuous streams of time series data, you may consider using a [data stream](./data-store/data-streams.md). These are optimally suited for storing append-only data. The data can be accessed through a single, named resource, while it is stored in a series of hidden, auto-generated backing indices.
21+
If your use case involves working with continuous streams of time series data, you can consider using a [data stream](./data-store/data-streams.md). These are optimally suited for storing append-only data. You can access the data through a single, named resource, while {{es}} stores it in a series of hidden, auto-generated backing indices.

manage-data/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,31 @@ description: Learn how to ingest, store, and manage data in Elasticsearch. Under
99

1010
# Manage data
1111

12-
Whether you're looking to build a fast and relevant search solution, monitor business-critical applications and infrastructure, monitor endpoint security data, or one of the [many other use cases Elastic supports](/get-started/introduction.md), you'll need to understand how to ingest and manage data stored in {{es}}.
12+
Whether you're looking to build a fast and relevant search solution, monitor business-critical applications and infrastructure, monitor endpoint security data, or one of the [many other use cases Elastic supports](/get-started/introduction.md), you need to understand how to ingest and manage data stored in {{es}}.
1313

1414
## Learn how data is stored
1515

1616
% Topic: Learning about Elastic data store primitives
1717

18-
The fundamental unit of storage in {{es}}, the index, is a collection of documents uniquely identified by a name or an alias. These documents go through a process called mapping, which defines how a document and the fields it contains are stored and indexed, and a process called text analysis in which unstructured text is converted into a structured format thats optimized for search.
18+
The fundamental unit of storage in {{es}}, the index, is a collection of documents uniquely identified by a name or an alias. These documents go through a process called mapping, which defines how {{es}} stores and indexes a document and the fields it contains, and a process called text analysis in which {{es}} converts unstructured text into a structured format that's optimized for search.
1919

2020
**Learn more in [The Elasticsearch data store](/manage-data/data-store.md)**.
2121

2222
## Get data into {{es}}
2323

2424
% Topic: Evaluating and implementing ingestion and data enrichment technologies
2525

26-
Before you can start searching, visualizing, and pulling actionable insights from Elastic, you have to get your data into {{es}}. Elastic offers a wide range of tools and methods for getting data into {{es}}. The best approach will depend on the kind of data you're ingesting and your specific use case.
26+
Before you can start searching, visualizing, and pulling actionable insights from Elastic, you have to get your data into {{es}}. Elastic offers a wide range of tools and methods for getting data into {{es}}. The best approach depends on the kind of data you're ingesting and your specific use case.
2727

2828
**Learn more in [Ingestion](/manage-data/ingest.md).**
2929

3030
## Manage data over time
3131

3232
% Topic: Managing your data volume (lifecycle)
3333

34-
After you've added data to {{es}}, you'll need to manage it over time. For example, you may specify that data be deleted after a retention period or store data in multiple tiers with different performance characteristics.
34+
After you've added data to {{es}}, you need to manage it over time. For example, you can specify that data be deleted after a retention period or store data in multiple tiers with different performance characteristics.
3535

36-
Strategies for managing data depend on the type of data and how it's being used. For example, with a collection of items you want to search, like a catalog of products, the value of the content remains relatively constant over time so you want to be able to retrieve items quickly regardless of how old they are. Whereas with a stream of continuously-generated timestamped data, such as log entries, the data keeps accumulating over time, so you need strategies for balancing the value of the data against the cost of storing it.
36+
Strategies for managing data depend on the type of data and how you're using it. For example, with a collection of items you want to search, like a catalog of products, the value of the content remains relatively constant over time so you want to be able to retrieve items quickly regardless of how old they are. Whereas with a stream of continuously-generated timestamped data, such as log entries, the data keeps accumulating over time, so you need strategies for balancing the value of the data against the cost of storing it.
3737

3838
**Learn more in [Data lifecycle](/manage-data/lifecycle.md).**
3939

manage-data/ingest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ products:
1919

2020
Whether you call it *adding*, *indexing*, or *ingesting* data, you have to get the data into {{es}} before you can search it, visualize it, and use it for insights.
2121

22-
Our ingest tools are flexible, and support a wide range of scenarios. We can help you with everything from popular and straightforward use cases, all the way to advanced use cases that require additional processing in order to modify or reshape your data before it goes to {{es}}.
22+
Our ingest tools are flexible, and support a wide range of scenarios. We can help you with everything from popular and straightforward use cases, all the way to advanced use cases that require additional processing to modify or reshape your data before it goes to {{es}}.
2323

2424
You can ingest:
2525

@@ -42,10 +42,10 @@ If you would like to try things out before you add your own data, try using our
4242

4343
## Ingesting time series data [ingest-time-series]
4444

45-
::::{admonition} Whats the best approach for ingesting time series data?
45+
::::{admonition} What's the best approach for ingesting time series data?
4646
The best approach for ingesting data is the *simplest option* that *meets your needs* and *satisfies your use case*.
4747

48-
In most cases, the *simplest option* for ingesting time series data is using {{agent}} paired with an Elastic integration.
48+
Usually, the *simplest option* for ingesting time series data is using {{agent}} paired with an Elastic integration.
4949

5050
* Install [Elastic Agent](/reference/fleet/index.md) on the computer(s) from which you want to collect data.
5151
* Add the [Elastic integration](https://docs.elastic.co/en/integrations) for the data source to your deployment.

manage-data/lifecycle.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The data you store in {{es}} generally falls into one of two categories:
2222
To help you manage your data, {{es}} offers you the following options: {{ilm-cap}}, Data stream lifecycle, and Elastic Curator.
2323

2424
::::{note}
25-
[Data rollup](/manage-data/lifecycle/rollup.md) is a deprecated {{es}} feature that allows you to manage the amount of data that is stored in your cluster, similar to the downsampling functionality of {{ilm-init}} and data stream lifecycle. This feature should not be used for new deployments.
25+
[Data rollup](/manage-data/lifecycle/rollup.md) is a deprecated {{es}} feature that allows you to manage the amount of data that your cluster stores, similar to the downsampling functionality of{{ilm-init}} and data stream lifecycle. Do not use this feature for new deployments.
2626
::::
2727

2828
## {{ilm-init}} [ilm]
@@ -40,9 +40,9 @@ In an {{ecloud}} or self-managed environment, ILM lets you automatically transit
4040
:::
4141
::::
4242

43-
**{{ilm-init}}** can be used to manage both indices and data streams. It allows you to do the following:
43+
**{{ilm-init}}** can manage both indices and data streams. It allows you to do the following:
4444

45-
* Define the retention period of your data. The retention period is the minimum time your data will be stored in {{es}}. Data older than this period can be deleted by {{es}}.
45+
* Define the retention period of your data. The retention period is the minimum time {{es}} stores your data. {{es}} can delete data older than this period.
4646
* Define [multiple tiers](/manage-data/lifecycle/data-tiers.md) of data nodes with different performance characteristics.
4747
* Automatically transition indices through the data tiers according to your performance needs and retention policies.
4848
* Leverage [searchable snapshots](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md) stored in a remote repository to provide resiliency for your older indices while reducing operating costs and maintaining search performance.
@@ -52,10 +52,10 @@ In an {{ecloud}} or self-managed environment, ILM lets you automatically transit
5252

5353
## Data stream lifecycle [data-stream-lifecycle]
5454

55-
**Data stream lifecycle** is less feature rich but is focused on simplicity. It allows you to do the following:
55+
**Data stream lifecycle** is less feature rich but focuses on simplicity. It allows you to do the following:
5656

57-
* Define the retention period of your data. The retention period is the minimum time your data will be stored in {{es}}. Data older than this period can be deleted by {{es}} at a later time.
58-
* Improve the performance of your data stream by performing background operations that will optimize the way your data stream is stored.
57+
* Define the retention period of your data. The retention period is the minimum time {{es}} stores your data. {{es}} can delete data older than this period at a later time.
58+
* Improve the performance of your data stream by performing background operations that optimize how {{es}} stores your data stream.
5959

6060
**[Read more in Data stream lifecycle ->](/manage-data/lifecycle/data-stream.md)**
6161

@@ -64,6 +64,6 @@ In an {{ecloud}} or self-managed environment, ILM lets you automatically transit
6464
serverless: unavailable
6565
```
6666

67-
**Elastic Curator** is a tool that allows you to manage your indices and snapshots using user-defined filters and predefined actions. If ILM provides the functionality to manage your index lifecycle, and you have at least a Basic license, consider using ILM in place of Curator. Many stack components make use of ILM by default.
67+
**Elastic Curator** is a tool that allows you to manage your indices and snapshots using user-defined filters and predefined actions. If ILM provides the functionality to manage your index lifecycle, and you have at least a Basic license, consider using ILM in place of Curator. Many stack components use ILM by default.
6868

6969
**[Read more in Elastic Curator ->](/manage-data/lifecycle/curator.md)**

0 commit comments

Comments
 (0)