Skip to content

Commit 6db415f

Browse files
Remove duplicate subs, subs for generic words, and outdated terms (elastic#4042)
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> Related to elastic#3536 ## Background In my opinion, `subs` aren't as helpful if we don't use them consistently. In elastic/elastic-docs-vscode#2, we added inline warnings when an author hard-codes the value of a sub instead of using the sub key, which provides a light-touch way to encourage consistent use of subs and weed out unnecessary subs without introducing a bunch of errors. ## Summary Removes duplicate subs (different keys for the same value), subs for generic words/phrases (like `Examples`, `API keys`, `transform`), and outdated terms (like `X-Pack`). This PR removes the least controversial items, but as @florent-leborgne mentions in elastic#3536 (comment), we can probably eliminate a lot more. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: Lisa Cawley <[email protected]>
1 parent c3c372e commit 6db415f

File tree

51 files changed

+367
-379
lines changed

Some content is hidden

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

51 files changed

+367
-379
lines changed

deploy-manage/api-keys/serverless-project-api-keys.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In serverless projects, the following types of API keys exist:
1414
- **Personal** API keys, that you can create to allow external services to access your serverless project on behalf of a user.
1515
- **Managed** API keys, created and managed by {{kib}} to correctly run background tasks.
1616

17-
You can manage your keys in **{{project-settings}} → {{manage-app}} → {{api-keys-app}}**:
17+
You can manage your keys in **{{project-settings}} → {{manage-app}} → API keys**:
1818

1919
:::{image} /deploy-manage/images/serverless-api-key-management.png
2020
:alt: API keys UI
@@ -24,7 +24,7 @@ You can manage your keys in **{{project-settings}} → {{manage-app}} → {{api-
2424

2525
## Create an API key [api-keys-create-an-api-key]
2626

27-
In **{{api-keys-app}}**, click **Create API key**:
27+
In **API keys**, click **Create API key**:
2828

2929
:::{image} /deploy-manage/images/serverless-create-personal-api-key.png
3030
:alt: Create API key UI
@@ -77,11 +77,11 @@ For the `role_descriptors` object schema, check out the [`/_security/api_key` en
7777

7878
## Update an API key [api-keys-update-an-api-key]
7979

80-
In **{{api-keys-app}}**, click on the name of the key. You can update only **Restrict privileges** and **Include metadata**.
80+
In **API keys**, click on the name of the key. You can update only **Restrict privileges** and **Include metadata**.
8181

8282

8383
## View and delete API keys [api-keys-view-and-delete-api-keys]
8484

85-
The **{{api-keys-app}}** app lists your API keys, including the name, date created, and status. When API keys expire, the status changes from `Active` to `Expired`.
85+
The **API keys** app lists your API keys, including the name, date created, and status. When API keys expire, the status changes from `Active` to `Expired`.
8686

8787
You can delete API keys individually or in bulk.

deploy-manage/autoscaling/autoscaling-deciders.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The estimation of expected additional data is based on past indexing that occurr
6868
: (Optional, [time value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#time-units)) The window of time to use for forecasting. Defaults to 30 minutes.
6969

7070

71-
### {{api-examples-title}} [autoscaling-proactive-storage-decider-examples]
71+
### Examples [autoscaling-proactive-storage-decider-examples]
7272

7373
This example puts an autoscaling policy named `my_autoscaling_policy`, overriding the proactive decider’s `forecast_window` to be 10 minutes.
7474

@@ -143,7 +143,7 @@ Both `num_anomaly_jobs_in_queue` and `num_analytics_jobs_in_queue` are designed
143143
: (Optional, [time value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Specifies the time to delay before scaling down. Defaults to 1 hour. If a scale down is possible for the entire time window, then a scale down is requested. If the cluster requires a scale up during the window, the window is reset.
144144

145145

146-
### {{api-examples-title}} [autoscaling-machine-learning-decider-examples]
146+
### Examples [autoscaling-machine-learning-decider-examples]
147147

148148
This example creates an autoscaling policy named `my_autoscaling_policy` that overrides the default configuration of the {{ml}} decider.
149149

@@ -198,7 +198,7 @@ The [autoscaling](../../deploy-manage/autoscaling.md) `fixed` decider responds w
198198
: (Optional, integer) Number of nodes to use when calculating capacity. Defaults to `1`.
199199

200200

201-
### {{api-examples-title}} [autoscaling-fixed-decider-examples]
201+
### Examples [autoscaling-fixed-decider-examples]
202202

203203
This example puts an autoscaling policy named `my_autoscaling_policy`, enabling and configuring the fixed decider.
204204

deploy-manage/deploy/self-managed/air-gapped-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ WantedBy=default.target
243243

244244
## {{artifact-registry}} [air-gapped-elastic-artifact-registry]
245245

246-
Air-gapped install of the {{artifact-registry}} is necessary in order to enable {{agent}} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/reference/fleet/air-gapped.md#host-artifact-registry) in the {{fleet}} and {{elastic-agent}} Guide.
246+
Air-gapped install of the {{artifact-registry}} is necessary in order to enable {{agent}} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/reference/fleet/air-gapped.md#host-artifact-registry) in the {{fleet}} and {{agent}} Guide.
247247

248248
::::{note}
249249
When setting up own web server, such as NGINX, to function as the {{artifact-registry}}, it is recommended not to use TLS as there are, currently, no direct ways to establish certificate trust between {{agents}} and this service.

deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ Some {{stack}} features also require specific node roles:
4141

4242
* {{ccs-cap}} and {{ccr}} require the `remote_cluster_client` role.
4343
* {{stack-monitor-app}} and ingest pipelines require the `ingest` role.
44-
* {{fleet}}, the {{security-app}}, and {{transforms}} require the `transform` role. The `remote_cluster_client` role is also required to use {{ccs}} with these features.
44+
* {{fleet}}, the {{security-app}}, and transforms require the `transform` role. The `remote_cluster_client` role is also required to use {{ccs}} with these features.
4545
* {{ml-cap}} features, such as {{anomaly-detect}}, require the `ml` role.
4646

4747
::::
4848

4949

50-
As the cluster grows and in particular if you have large {{ml}} jobs or {{ctransforms}}, consider separating dedicated master-eligible nodes from dedicated data nodes, {{ml}} nodes, and {{transform}} nodes.
50+
As the cluster grows and in particular if you have large {{ml}} jobs or {{ctransforms}}, consider separating dedicated master-eligible nodes from dedicated data nodes, {{ml}} nodes, and transform nodes.
5151

5252

5353
## Change the role of a node [change-node-role]
@@ -82,7 +82,7 @@ The following is a list of the roles that a node can perform in a cluster. A nod
8282
* [Ingest node](#node-ingest-node) (`ingest`): Ingest nodes are able to apply an [ingest pipeline](../../../manage-data/ingest/transform-enrich/ingest-pipelines.md) to a document in order to transform and enrich the document before indexing. With a heavy ingest load, it makes sense to use dedicated ingest nodes and to not include the `ingest` role from nodes that have the `master` or `data` roles.
8383
* [Remote-eligible node](#remote-node) (`remote_cluster_client`): A node that is eligible to act as a remote client.
8484
* [Machine learning node](#ml-node-role) (`ml`): A node that can run {{ml-features}}. If you want to use {{ml-features}}, there must be at least one {{ml}} node in your cluster. For more information, see [Machine learning settings](../../deploy/self-managed/configure-elasticsearch.md) and [Machine learning in the {{stack}}](/explore-analyze/machine-learning.md).
85-
* [{{transform-cap}} node](#transform-node-role) (`transform`): A node that can perform {{transforms}}. If you want to use {{transforms}}, there must be at least one {{transform}} node in your cluster. For more information, see [{{transforms-cap}} settings](../../deploy/self-managed/configure-elasticsearch.md) and [*Transforming data*](../../../explore-analyze/transforms.md).
85+
* [Transform node](#transform-node-role) (`transform`): A node that can perform transforms. If you want to use transforms, there must be at least one transform node in your cluster. For more information, see [Transforms settings](../../deploy/self-managed/configure-elasticsearch.md) and [*Transforming data*](../../../explore-analyze/transforms.md).
8686

8787
::::{admonition} Coordinating node
8888
:class: note
@@ -299,15 +299,15 @@ node.roles: [ ml, remote_cluster_client]
299299
The `remote_cluster_client` role is optional but strongly recommended. Otherwise, {{ccs}} fails when used in {{ml}} jobs or {{dfeeds}}. If you use {{ccs}} in your {{anomaly-jobs}}, the `remote_cluster_client` role is also required on all master-eligible nodes. Otherwise, the {{dfeed}} cannot start. See [Remote-eligible node](#remote-node).
300300

301301

302-
### {{transform-cap}} node [transform-node-role]
302+
### Transform node [transform-node-role]
303303

304-
{{transform-cap}} nodes run {{transforms}} and handle {{transform}} API requests. For more information, see [{{transforms-cap}} settings](../../deploy/self-managed/configure-elasticsearch.md).
304+
Transform nodes run transforms and handle transform API requests. For more information, see [Transforms settings](../../deploy/self-managed/configure-elasticsearch.md).
305305

306-
To create a dedicated {{transform}} node, set:
306+
To create a dedicated transform node, set:
307307

308308
```yaml
309309
node.roles: [ transform, remote_cluster_client ]
310310
```
311311

312-
The `remote_cluster_client` role is optional but strongly recommended. Otherwise, {{ccs}} fails when used in {{transforms}}. See [Remote-eligible node](#remote-node).
312+
The `remote_cluster_client` role is optional but strongly recommended. Otherwise, {{ccs}} fails when used in transforms. See [Remote-eligible node](#remote-node).
313313

deploy-manage/monitor/stack-monitoring/es-local-exporter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313
:::{include} _snippets/legacy-warning.md
1414
:::
1515

16-
The `local` exporter is the default exporter in {{monitoring}}. It routes data back into the same (local) cluster. In other words, it uses the production cluster as the monitoring cluster. For example:
16+
The `local` exporter is the default exporter in {{monitor-features}}. It routes data back into the same (local) cluster. In other words, it uses the production cluster as the monitoring cluster. For example:
1717

1818
```yaml
1919
xpack.monitoring.exporters.my_local_exporter: <1>
@@ -27,7 +27,7 @@ This exporter exists to provide a convenient option when hardware is simply not
2727
2828
* All indexing impacts the local cluster and the nodes that hold the monitoring indices' shards.
2929
* Most collectors run on the elected master node. Therefore most indexing occurs with the elected master node as the coordinating node, which is a bad practice.
30-
* Any usage of {{monitoring}} for {{kib}} uses the local cluster’s resources for searches and aggregations, which means that they might not be available for non-monitoring tasks.
30+
* Any usage of {{monitor-features}} for {{kib}} uses the local cluster’s resources for searches and aggregations, which means that they might not be available for non-monitoring tasks.
3131
* If the local cluster goes down, the monitoring cluster has inherently gone down with it (and vice versa), which generally defeats the purpose of monitoring.
3232
3333
For the `local` exporter, all setup occurs only on the elected master node. This means that if you do not see any monitoring templates or ingest pipelines, the elected master node is having issues or it is not configured in the same way. Unlike the `http` exporter, the `local` exporter has the advantage of accessing the monitoring cluster’s up-to-date cluster state. It can therefore always check that the templates and ingest pipelines exist without a performance penalty. If the elected master node encounters errors while trying to create the monitoring resources, it logs errors, ignores that collection, and tries again after the next collection.

deploy-manage/monitor/stack-monitoring/es-monitoring-collectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414
:::{include} _snippets/legacy-warning.md
1515
:::
1616

17-
Collectors, as their name implies, collect things. Each collector runs once for each collection interval to obtain data from the public APIs in {{es}} and {{xpack}} that it chooses to monitor. When the data collection is finished, the data is handed in bulk to the [exporters](es-monitoring-exporters.md) to be sent to the monitoring clusters. Regardless of the number of exporters, each collector only runs once per collection interval.
17+
Collectors, as their name implies, collect things. Each collector runs once for each collection interval to obtain data from the public APIs in {{es}} that it chooses to monitor. When the data collection is finished, the data is handed in bulk to the [exporters](es-monitoring-exporters.md) to be sent to the monitoring clusters. Regardless of the number of exporters, each collector only runs once per collection interval.
1818

1919
There is only one collector per data type gathered. In other words, for any monitoring document that is created, it comes from a single collector rather than being merged from multiple collectors. The {{es}} {{monitor-features}} currently have a few collectors because the goal is to minimize overlap between them for optimal performance.
2020

deploy-manage/monitor/stack-monitoring/es-pause-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ products:
1414
:::{include} _snippets/legacy-warning.md
1515
:::
1616

17-
To stop generating {{monitoring}} data in {{es}}, disable data collection:
17+
To stop generating monitoring data in {{es}}, disable data collection:
1818

1919
```yaml
2020
xpack.monitoring.collection.enabled: false
@@ -43,7 +43,7 @@ xpack.monitoring.exporters.my_http_exporter:
4343
1. Disable the named exporter. If the same name as an existing exporter is not used, then this will create a completely new exporter that is completely ignored. This value can be set dynamically by using cluster settings.
4444

4545

46-
::::{note}
46+
::::{note}
4747
Defining a disabled exporter prevents the default exporter from being created.
4848
::::
4949

deploy-manage/monitor/stack-monitoring/kibana-monitoring-metricbeat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To learn about monitoring in general, refer to [](/deploy-manage/monitor/stack-m
7272
For more information, see [Monitoring settings in {{es}}](elasticsearch://reference/elasticsearch/configuration-reference/monitoring-settings.md) and [the Cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings).
7373

7474
4. [Install {{metricbeat}}](beats://reference/metricbeat/metricbeat-installation-configuration.md) on the same server as {{kib}}.
75-
5. Enable the {{kib}} {{xpack}} module in {{metricbeat}}.<br>
75+
5. Enable the {{kib}} X-Pack module in {{metricbeat}}.<br>
7676

7777
For example, to enable the default configuration in the `modules.d` directory, run the following command:
7878

@@ -82,7 +82,7 @@ To learn about monitoring in general, refer to [](/deploy-manage/monitor/stack-m
8282

8383
For more information, see [Specify which modules to run](beats://reference/metricbeat/configuration-metricbeat.md) and [{{kib}} module](beats://reference/metricbeat/metricbeat-module-kibana.md).
8484

85-
6. Configure the {{kib}} {{xpack}} module in {{metricbeat}}.<br>
85+
6. Configure the {{kib}} X-Pack module in {{metricbeat}}.<br>
8686

8787
The `modules.d/kibana-xpack.yml` file contains the following settings:
8888

deploy-manage/remote-clusters/remote-clusters-migrate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ On the remote cluster:
109109

110110
On the local cluster, stop any persistent tasks that refer to the remote cluster:
111111

112-
* Use the [Stop {{transforms}}](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform) API to stop any transforms.
112+
* Use the [Stop transforms](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform) API to stop any transforms.
113113
* Use the [Close jobs](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job) API to close any anomaly detection jobs.
114114
* Use the [Pause auto-follow pattern](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern) API to pause any auto-follow {{ccr}}.
115115
* Use the [Pause follower](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow) API to pause any manual {{ccr}} or existing indices that were created from the auto-follow pattern.
@@ -218,7 +218,7 @@ On the local cluster:
218218

219219
Resume any persistent tasks that you stopped earlier. Tasks should be restarted by the same user or API key that created the task before the migration. Ensure the roles of this user or API key have been updated with the required `remote_indices` or `remote_cluster` privileges. For users, tasks capture the caller’s credentials when started and run in that user’s security context. For API keys, restarting a task will update the task with the updated API key.
220220

221-
* Use the [Start {{transform}}](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform) API to start any transforms.
221+
* Use the [Start transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform) API to start any transforms.
222222
* Use the [Open jobs](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job) API to open any anomaly detection jobs.
223223
* Use the [Resume follower](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow) API to resume any auto-follow {{ccr}}.
224224
* Use the [Resume auto-follow pattern](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern) API to resume any manual {{ccr}} or existing indices that were created from the auto-follow pattern.

docset.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,7 @@ subs:
128128
project-settings: "Project settings"
129129
manage-app: "Management"
130130
index-manage-app: "Index Management"
131-
rules-app: "Rules"
132131
saved-objects-app: "Saved Objects"
133-
api-keys-app: "API keys"
134-
connectors-app: "Connectors"
135132
reports-app: "Reports"
136133
app-search-crawler: "App Search web crawler"
137134
agent: "Elastic Agent"
@@ -144,7 +141,6 @@ subs:
144141
artifact-registry: "Elastic Artifact Registry"
145142
aws: "AWS"
146143
stack: "Elastic Stack"
147-
xpack: "X-Pack"
148144
es: "Elasticsearch"
149145
kib: "Kibana"
150146
ls: "Logstash"
@@ -156,7 +152,6 @@ subs:
156152
packetbeat: "Packetbeat"
157153
winlogbeat: "Winlogbeat"
158154
esql: "ES|QL"
159-
elastic-agent: "Elastic Agent"
160155
k8s: "Kubernetes"
161156
security-features: "security features"
162157
operator-feature: "operator privileges feature"
@@ -177,7 +172,6 @@ subs:
177172
webhook-cm: "Webhook - Case Management"
178173
opsgenie: "Opsgenie"
179174
hive: "TheHive"
180-
monitoring: "X-Pack monitoring"
181175
monitor-features: "monitoring features"
182176
stack-monitor-features: "Elastic Stack monitoring features"
183177
watcher: "Watcher"
@@ -225,10 +219,6 @@ subs:
225219
watcher-transform: "payload transform"
226220
watcher-transforms: "payload transforms"
227221
watcher-transforms-cap: "Payload transforms"
228-
transform: "transform"
229-
transforms: "transforms"
230-
transform-cap: "Transform"
231-
transforms-cap: "Transforms"
232222
dfanalytics-cap: "Data frame analytics"
233223
dfanalytics: "data frame analytics"
234224
dfanalytics-job: "data frame analytics analytics job"
@@ -270,8 +260,6 @@ subs:
270260
private-locations: "Private Locations"
271261
esh: "ES-Hadoop"
272262
observability: "Observability"
273-
api-query-parms-title: "Query parameters"
274-
api-examples-title: "Examples"
275263
agent-pull: "https://github.com/elastic/elastic-agent/pull/"
276264
es-pull: "https://github.com/elastic/elasticsearch/pull/"
277265
kib-pull: "https://github.com/elastic/kibana/pull/"

0 commit comments

Comments
 (0)