[OSCI][DOCs] Replacing 'indices' terms for 'indexes' terms ONLY for d…

…escription texts (#5353) * Fixing documentation for Wildcard in term-level queries section for Query DSL Signed-off-by: Samuel Valdes Gutierrez <[email protected]> * replacing 'indices' term for 'indexes' term ONLY for description texts (not variables, links or properties) Signed-off-by: Samuel Valdes Gutierrez <[email protected]> * Update creating-custom-workloads.md Signed-off-by: Naarcha-AWS <[email protected]> * updating changes suggested by Naarcha-AWS Signed-off-by: Samuel Valdes Gutierrez <[email protected]> * updating changes suggested by Naarcha-AWS Signed-off-by: Samuel Valdes Gutierrez <[email protected]> * Rename _benchmark/workloads/index.md to _benchmark/workloads/reference/index.md Signed-off-by: Naarcha-AWS <[email protected]> * Rename _benchmark/workloads/indices.md to _benchmark/workloads/reference/indices.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Samuel Valdes Gutierrez <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-project · Oct 31, 2023 · 7012af1 · 7012af1
1 parent f9e0c02
commit 7012af1
Show file tree

Hide file tree

Showing 16 changed files with 267 additions and 117 deletions.
diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md
@@ -53,7 +53,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
 Parameter | Type | Description
 :--- | :--- | :---
 local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
+expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
 
 ## Response
 

diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md
@@ -12,7 +12,7 @@ redirect_from:
 **Introduced 1.0**
 {: .label .label-purple }
 
-The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
+The CAT indexes operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
 
 ## Example
 
@@ -44,7 +44,7 @@ GET _cat/indices
 
 ## URL parameters
 
-All CAT indices URL parameters are optional.
+All CAT indexes URL parameters are optional.
 
 In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
 

diff --git a/_api-reference/count.md b/_api-reference/count.md
@@ -2,7 +2,7 @@
 layout: default
 title: Count
 nav_order: 21
-redirect_from: 
+redirect_from:
  - /opensearch/rest-api/count/
 ---
 
@@ -61,7 +61,7 @@ GET _count
 ```
 {% include copy-curl.html %}
 
-Alternatively, you could use the [cat indices]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/) and [cat count]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-count/) APIs to see the number of documents per index or data stream.
+Alternatively, you could use the [cat indexes]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/) and [cat count]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-count/) APIs to see the number of documents per index or data stream.
 {: .note }
 
 

diff --git a/_api-reference/document-apis/bulk.md b/_api-reference/document-apis/bulk.md
@@ -57,7 +57,7 @@ refresh | Enum | Whether to refresh the affected shards after performing the ind
 require_alias | Boolean | Set to `true` to require that all actions target an index alias rather than an index. Default is `false`.
 routing | String | Routes the request to the specified shard.
 timeout | Time | How long to wait for the request to return. Default `1m`.
-type | String | (Deprecated) The default document type for documents that don't specify a type. Default is `_doc`. We highly recommend ignoring this parameter and using a type of `_doc` for all indices.
+type | String | (Deprecated) The default document type for documents that don't specify a type. Default is `_doc`. We highly recommend ignoring this parameter and using a type of `_doc` for all indexes.
 wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the bulk request. Default is 1 (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
 {% comment %}_source | List | asdf
 _source_excludes | list | asdf
@@ -114,15 +114,15 @@ All actions support the same metadata: `_index`, `_id`, and `_require_alias`. If
   { "update": { "_index": "movies", "_id": "tt0816711" } }
   { "doc" : { "title": "World War Z" } }
   ```
-  
+
   It can also include a script or upsert for more complex document updates.
 
   - Script
   ```json
   { "update": { "_index": "movies", "_id": "tt0816711" } }
   { "script" : { "source": "ctx._source.title = \"World War Z\"" } }
   ```
-  
+
   - Upsert
   ```json
   { "update": { "_index": "movies", "_id": "tt0816711" } }

diff --git a/_api-reference/document-apis/delete-by-query.md b/_api-reference/document-apis/delete-by-query.md
@@ -3,7 +3,7 @@ layout: default
 title: Delete by query
 parent: Document APIs
 nav_order: 40
-redirect_from: 
+redirect_from:
  - /opensearch/rest-api/document-apis/delete-by-query/
 ---
 
@@ -39,16 +39,16 @@ All URL parameters are optional.
 
 Parameter | Type | Description
 :--- | :--- | :--- | :---
-&lt;index&gt; | String | Name or list of the data streams, indices, or aliases to delete from. Supports wildcards. If left blank, OpenSearch searches all indices.
-allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indices. Default is `true`.
+&lt;index&gt; | String | Name or list of the data streams, indexes, or aliases to delete from. Supports wildcards. If left blank, OpenSearch searches all indexes.
+allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`.
 analyzer | String | The analyzer to use in the query string.
 analyze_wildcard | Boolean | Specifies whether to analyze wildcard and prefix queries. Default is false.
 conflicts | String | Indicates to OpenSearch what should happen if the delete by query operation runs into a version conflict. Valid options are `abort` and `proceed`. Default is `abort`.
 default_operator | String | Indicates whether the default operator for a string query should be AND or OR. Default is OR.
 df | String | The default field in case a field prefix is not provided in the query string.
-expand_wildcards | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indices), `closed` (match closed, non-hidden indices), `hidden` (match hidden indices), and `none` (deny wildcard expressions). Default is `open`.
+expand_wildcards | String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are `all` (match any index), `open` (match open, non-hidden indexes), `closed` (match closed, non-hidden indexes), `hidden` (match hidden indexes), and `none` (deny wildcard expressions). Default is `open`.
 from | Integer | The starting index to search from. Default is 0.
-ignore_unavailable | Boolean | Specifies whether to include missing or closed indices in the response. Default is false.
+ignore_unavailable | Boolean | Specifies whether to include missing or closed indexes in the response. Default is false.
 lenient | Boolean | Specifies whether OpenSearch should accept requests if queries have format errors (for example, querying a text field for an integer). Default is false.
 max_docs | Integer | How many documents the delete by query operation should process at most. Default is all documents.
 preference | String | Specifies which shard or node OpenSearch should perform the delete by query operation on.

diff --git a/_api-reference/popular-api.md b/_api-reference/popular-api.md
@@ -81,22 +81,22 @@ POST _bulk
 ```
 
 
-## List all indices
+## List all indexes
 
 ```
 GET _cat/indices?v&expand_wildcards=all
 ```
 
 
-## Open or close all indices that match a pattern
+## Open or close all indexes that match a pattern
 
 ```
 POST my-logs*/_open
 POST my-logs*/_close
 ```
 
 
-## Delete all indices that match a pattern
+## Delete all indexes that match a pattern
 
 ```
 DELETE my-logs*
@@ -119,7 +119,7 @@ GET _cat/aliases?v
 ```
 
 
-## Search an index or all indices that match a pattern
+## Search an index or all indexes that match a pattern
 
 ```
 GET my-logs/_search?q=test

diff --git a/_benchmark/user-guide/concepts.md b/_benchmark/user-guide/concepts.md
@@ -94,8 +94,8 @@ A workload usually includes the following elements:
 
 - [indices]({{site.url}}{{site.baseurl}}/benchmark/workloads/indices/): Defines the relevant indexes and index templates used for the workload.
 - [corpora]({{site.url}}{{site.baseurl}}/benchmark/workloads/corpora/): Defines all document corpora used for the workload.
-- `schedule`: Defines operations and the order in which the operations run inline. Alternatively, you can use `operations` to group operations and the `test_procedures` parameter to specify the order of operations. 
-- `operations`: **Optional**. Describes which operations are available for the workload and how they are parameterized. 
+- `schedule`: Defines operations and the order in which the operations run inline. Alternatively, you can use `operations` to group operations and the `test_procedures` parameter to specify the order of operations.
+- `operations`: **Optional**. Describes which operations are available for the workload and how they are parameterized.
 
 ### Indices
 
@@ -105,9 +105,9 @@ To create an index, specify its `name`. To add definitions to your index, use th
 
 The `corpora` element requires the name of the index containing the document corpus, for example, `movies`, and a list of parameters that define the document corpora. This list includes the following parameters:
 
--  `source-file`: The file name that contains the workload's corresponding documents. When using OpenSearch Benchmark locally, documents are contained in a JSON file. When providing a `base_url`, use a compressed file format: `.zip`, `.bz2`, `.gz`, `.tar`, `.tar.gz`, `.tgz`, or `.tar.bz2`. The compressed file must have one JSON file containing the name. 
--  `document-count`: The number of documents in the `source-file`, which determines which client indexes correlate to which parts of the document corpus. Each N client receives an Nth of the document corpus. When using a source that contains a document with a parent-child relationship, specify the number of parent documents. 
-- `uncompressed-bytes`: The size, in bytes, of the source file after decompression, indicating how much disk space the decompressed source file needs. 
+-  `source-file`: The file name that contains the workload's corresponding documents. When using OpenSearch Benchmark locally, documents are contained in a JSON file. When providing a `base_url`, use a compressed file format: `.zip`, `.bz2`, `.gz`, `.tar`, `.tar.gz`, `.tgz`, or `.tar.bz2`. The compressed file must have one JSON file containing the name.
+-  `document-count`: The number of documents in the `source-file`, which determines which client indexes correlate to which parts of the document corpus. Each N client receives an Nth of the document corpus. When using a source that contains a document with a parent-child relationship, specify the number of parent documents.
+- `uncompressed-bytes`: The size, in bytes, of the source file after decompression, indicating how much disk space the decompressed source file needs.
 - `compressed-bytes`: The size, in bytes, of the source file before decompression. This can help you assess the amount of time needed for the cluster to ingest documents.
 
 ### Operations
@@ -116,7 +116,7 @@ The `operations` element lists the OpenSearch API operations performed by the wo
 
 ### Schedule
 
-The `schedule` element contains a list of actions and operations that are run by the workload. Operations run according to the order in which they appear in the `schedule`. The following example illustrates a `schedule` with multiple operations, each defined by its `operation-type`: 
+The `schedule` element contains a list of actions and operations that are run by the workload. Operations run according to the order in which they appear in the `schedule`. The following example illustrates a `schedule` with multiple operations, each defined by its `operation-type`:
 
 ```json
   "schedule": [