Skip to content

Commit 8e066c7

Browse files
[docs] Fix various syntax and rendering errors (#1233)
Fixes various syntax and rendering errors that might include: * Fixing broken images * Hardcoding book-level substitution values * Fixing incorrectly closed blocks (admonitions, tab sets, code blocks, dropdowns etc.) * Fixing poorly migrated complex tables * Fixing poorly migrated lists * Fixing poorly migrated tab sets * Removing inline text formatting from directive titles where they won't be rendered (for example, inline `code` formatting in dropdown titles) * Specifying if a version is trying to communicate if a feature was added, deprecated, or coming (for example, during migration `deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any information about _what_ happened in 8.15.0) * Fixing nested dropdowns / definition lists * Fixing poorly migrated footnotes * Updating references to prerelease `9.0.0` versions (using a repo-level substitution until there is a solution to elastic/docs-builder#737)
1 parent 1db1807 commit 8e066c7

File tree

138 files changed

+666
-484
lines changed

Some content is hidden

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

138 files changed

+666
-484
lines changed

deploy-manage/autoscaling/autoscaling-in-eck.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ kubectl get elasticsearchautoscaler autoscaling-sample \
222222
-o jsonpath='{ .status.conditions }' | jq
223223
```
224224

225-
```json
225+
```json subs=true
226226
[
227227
{
228228
"lastTransitionTime": "2022-09-09T08:07:10Z",

deploy-manage/cloud-organization/billing/billing-models.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ Based on these four key concepts, the prepaid consumption lifecycle is as follow
7171
1. You purchase credits expressed in ECU, typically at a discount.
7272
2. You begin using {{ecloud}} resources.
7373
3. At every billing cycle (which takes place on the first of each month), the previous month's usage, expressed in ECU, is deducted from your ECU balance.
74-
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.¹
74+
4. If your ECU balance is depleted before the credit expiration date, you are invoiced for on-demand usage in arrears at list price. On-demand usage is expressed in ECU, and is converted to currency amounts for invoicing purposes.[^1^](#footnote-1)
7575
5. At the end of the contract period, any credits remaining in your balance are forfeited.
76-
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.²
76+
6. During the contract period, you can purchase additional credits at any time (as an add-on). This can be done with the same discount as the original purchase. Credits purchased through an add-on have the same expiration as the original purchase.[^2^](#footnote-2)
7777

78-
¹ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
78+
^1^ $$$footnote-1$$$ When you renew your contract or commit to a multi-year contract, any on-demand usage incurred in the years other than the last are billed with the same discount as the original purchase.
7979

80-
² Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
80+
^2^ $$$footnote-2$$$ Purchasing credits through early renewals, or through add-ons with different expiration dates will be available in the near future.
8181

8282
::::{note}
8383
Existing annual+overages customers will be able to switch to prepaid consumption when they renew or sign a new contract. Existing manual burndown customers will be migrated gradually to prepaid consumption in the near future. Exceptions apply.

deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ There are a number of fields that need to be added to each {{es}} node in order
3030

3131
The following example is based on the `default` system owned deployment template that already supports `node_roles`. This template will be used as a reference for the next sections:
3232

33-
::::{dropdown} Reference example with support for `node_roles`
33+
::::{dropdown} Reference example with support for node_roles
3434
:name: ece-node-roles-support-example
3535

3636
```json
@@ -363,7 +363,7 @@ It is recommended to add the `id` field to each {{es}} topology element in the d
363363

364364
The existing template contains three {{es}} topology elements and two resources (`elasticsearch` and `kibana`).
365365

366-
::::{dropdown} Custom example without support for `node_roles`
366+
::::{dropdown} Custom example without support for node_roles
367367
```json
368368
{
369369
...
@@ -471,7 +471,7 @@ Then, it is only necessary to add the four {{es}} topology elements (`warm`, `co
471471

472472
After adding support for `node_roles`, the resulting deployment template should look similar to the following:
473473

474-
::::{dropdown} Custom example with support for `node_roles`
474+
::::{dropdown} Custom example with support for node_roles
475475
:name: example-with-support-for-node-roles
476476

477477
```json
@@ -772,7 +772,7 @@ These fields represent the default settings for the deployment. However, autosca
772772

773773
Similar to the `node_roles` example, the following one is also based on the `default` deployment template that already supports `node_roles` and autoscaling. This template will be used as a reference for the next sections:
774774

775-
::::{dropdown} Reference example with support for `node_roles` and autoscaling
775+
::::{dropdown} Reference example with support for node_roles and autoscaling
776776
```json
777777
{
778778
...
@@ -1102,7 +1102,7 @@ To update a custom deployment template:
11021102

11031103
After adding support for autoscaling to the [example](#ece-node-roles-support-example) presented in the previous section, the resulting deployment template should look similar to the following:
11041104

1105-
::::{dropdown} Custom example with support for `node_roles` and autoscaling
1105+
::::{dropdown} Custom example with support for node_roles and autoscaling
11061106
```json
11071107
{
11081108
...
@@ -1780,7 +1780,7 @@ After the migration plan has finished, we recommend following the [Migrate index
17801780

17811781
The following is an example of a deployment plan that does not contain `node_roles`:
17821782

1783-
::::{dropdown} Example deployment plan with `node_type`
1783+
::::{dropdown} Example deployment plan with node_type
17841784
```json
17851785
{
17861786
"name": "Example deployment",
@@ -1924,7 +1924,7 @@ The following is an example of a deployment plan that does not contain `node_rol
19241924

19251925
After adding support for `node_roles` to the example deployment plan, the resulting plan should look similar to the following:
19261926

1927-
::::{dropdown} Example deployment plan with `node_roles`
1927+
::::{dropdown} Example deployment plan with node_roles
19281928
```json
19291929
{
19301930
"name": "Example deployment",

deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To perform an offline installation without a private Docker registry, you have t
2727
For example, for {{ece}} 4.0.0 and the {{stack}} versions it shipped with, you need:
2828

2929
* {{ece}} 4.0.0
30-
* {es} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
30+
* {{es}} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
3131

3232
2. Create .tar files of the images:
3333

deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ mapped_pages:
1010

1111
Custom endpoint aliases allow users to replace the UUID for each application with a human readable string. Platform administrators must enable this feature to allow deployment managers to create and modify aliases for their deployments.
1212

13-
::::{note}
13+
::::{note}
1414
You need to update your proxy certificates to support this feature.
1515
::::
1616

@@ -20,16 +20,16 @@ After installing or upgrading to version 2.10 or later:
2020
1. [Login to the Cloud UI](log-into-cloud-ui.md)
2121
2. [Update your proxy certificate(s)](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). In addition to currently configured domains, additional SAN entries must be configured for each application-specific subdomain:
2222

23-
::::{note}
23+
::::{note}
2424
If you are not using wildcard certificates, you need to repeat this process for each deployment to account for specific aliases.
2525
::::
2626

2727

28-
* For {{es}}, the certificate needs to allow for ***.es.<your-domain>**
29-
* For {{kib}}, the certificate needs to allow for ***.kb.<your-domain>**
30-
* For APM, the certificate needs to allow for ***.apm.<your-domain>**
31-
* For Fleet, the certificate needs to allow for ***.fleet.<your-domain>**
32-
* For Universal Profiling, the certificate needs to allow for ***.profiling.<your-domain>** and ***.symbols.<your-domain>**
28+
* For {{es}}, the certificate needs to allow for **\*.es.<your-domain>**
29+
* For {{kib}}, the certificate needs to allow for **\*.kb.<your-domain>**
30+
* For APM, the certificate needs to allow for **\*.apm.<your-domain>**
31+
* For Fleet, the certificate needs to allow for **\*.fleet.<your-domain>**
32+
* For Universal Profiling, the certificate needs to allow for **\*.profiling.<your-domain>** and **\*.symbols.<your-domain>**
3333

3434
3. In the **Platform** menu, select **Settings**.
3535
4. Under the **Enable custom endpoint alias naming**, toggle the setting to allow platform administrators and deployment managers to choose a simplified, unique URL for the endpoint.

deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $$$ece-elastic-stack-stackpacks-recent$$$
4545

4646
Following is the full list of available packs containing {{stack}} versions. Note that Enterprise Search was introduced with ECE 2.6.0 and requires that version or higher.
4747

48-
::::{dropdown} **Expand to view the full list**
48+
::::{dropdown} Expand to view the full list
4949
| Required downloads | Minimum required ECE version |
5050
| --- | --- |
5151
| [{{es}}, {{kib}}, and APM stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |

deploy-manage/deploy/cloud-on-k8s/advanced-configuration.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ This section covers the following topics:
1717

1818
## Use APM Agent central configuration [k8s-apm-agent-central-configuration]
1919

20-
[APM Agent configuration management](/solutions/observability/apm/apm-agent-central-configuration.md) [7.5.1] allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:
20+
:::{admonition} Added in 7.5.1
21+
APM Agent central configuration was added in 7.5.1.
22+
:::
23+
24+
[APM Agent configuration management](/solutions/observability/apm/apm-agent-central-configuration.md) allows you to configure your APM Agents centrally from the {{kib}} APM app. To use this feature, the APM Server needs to be configured with connection details of the {{kib}} instance. If {{kib}} is managed by ECK, you can simply add a `kibanaRef` attribute to the APM Server specification:
2125

2226
```yaml
2327
cat <<EOF | kubectl apply -f -

deploy-manage/deploy/cloud-on-k8s/configuration-logstash.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,14 @@ Logstash persistent queues (PQs) and dead letter queues (DLQs) are not currently
174174

175175
## Defining data volumes for Logstash [k8s-logstash-volumes]
176176

177-
[2.9.0]
177+
:::{admonition} Added in 2.9.0
178+
This was added in 2.9.0.
179+
:::
178180

179181
::::{warning}
180182
Volume support for Logstash is a breaking change to earlier versions of ECK and requires you to recreate your Logstash resources.
181183
::::
182184

183-
184-
185185
## Specifying the volume claim settings [k8s-volume-claim-settings]
186186

187187
A PersistentVolume called `logstash-data` is created by default. It maps to `/usr/share/logstash/data` for persistent storage, which is typically used for storage from plugins.

deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -303,13 +303,13 @@ $$$azure-integration-whats-included$$$What is included in my {{ecloud}} deployme
303303
$$$azure-integration-how-to-access$$$How can I access my {{ecloud}} deployment?
304304
: Navigate to the deployment overview page in Azure:
305305

306-
1. Select a deployment to open the deployment overview page.
306+
Select a deployment to open the deployment overview page.
307307

308-
You now have a few options to access your deployment:
308+
Then you have a few options to access your deployment:
309309

310-
* **{{es}} endpoint** - the URL for the {{es}} cluster itself
311-
* **{{kib}} endpoint** - the UI for the {{stack}}, a great way for new users to get started
312-
* **{{ecloud}}** - Open the **Advanced Settings** link to access the deployment in the {{ecloud}} console, to change the size of the deployment or upgrade it.
310+
* **{{es}} endpoint** - the URL for the {{es}} cluster itself
311+
* **{{kib}} endpoint** - the UI for the {{stack}}, a great way for new users to get started
312+
* **{{ecloud}}** - Open the **Advanced Settings** link to access the deployment in the {{ecloud}} console, to change the size of the deployment or upgrade it.
313313

314314

315315
$$$azure-integration-modify-deployment$$$How can I modify my {{ecloud}} deployment?

deploy-manage/deploy/elastic-cloud/project-settings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For {{elastic-sec}} projects, edit the **Project features** to select a feature
6161
| Feature tier | Description and add-ons |
6262
| :--- | :--- |
6363
| **Security Analytics Essentials** | Standard security analytics, detections, investigations, and collaborations. Allows these add-ons:<br><br>* **Endpoint Protection Essentials**: endpoint protections with {{elastic-defend}}.<br>* **Cloud Protection Essentials**: Cloud native security features.<br> |
64-
| **Security Analytics Complete** | Everything in **Security Analytics Essentials*** plus advanced features such as entity analytics, threat intelligence, and more. Allows these add-ons:<br><br>* **Endpoint Protection Complete**: Everything in **Endpoint Protection Essentials** plus advanced endpoint detection and response features.<br>* **Cloud Protection Complete**: Everything in **Cloud Protection Essentials** plus advanced cloud security features.<br> |
64+
| **Security Analytics Complete** | Everything in **Security Analytics Essentials** plus advanced features such as entity analytics, threat intelligence, and more. Allows these add-ons:<br><br>* **Endpoint Protection Complete**: Everything in **Endpoint Protection Essentials** plus advanced endpoint detection and response features.<br>* **Cloud Protection Complete**: Everything in **Cloud Protection Essentials** plus advanced cloud security features.<br> |
6565
6666
### Downgrading the feature tier [elasticsearch-manage-project-downgrading-the-feature-tier]
6767

deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-voting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ It is important that the bootstrap configuration identifies exactly which nodes
5858
If the bootstrap configuration is not set correctly, when you start a brand-new cluster there is a risk that you will accidentally form two separate clusters instead of one. This situation can lead to data loss: you might start using both clusters before you notice that anything has gone wrong and it is impossible to merge them together later.
5959

6060
::::{note}
61-
To illustrate the problem with configuring each node to expect a certain cluster size, imagine starting up a three-node cluster in which each node knows that it is going to be part of a three-node cluster. A majority of three nodes is two, so normally the first two nodes to discover each other form a cluster and the third node joins them a short time later. However, imagine that four nodes were erroneously started instead of three. In this case, there are enough nodes to form two separate clusters. Of course if each node is started manually then it’s unlikely that too many nodes are started. If you’re using an automated orchestrator, however, it’s certainly possible to get into this situation-- particularly if the orchestrator is not resilient to failures such as network partitions.
61+
To illustrate the problem with configuring each node to expect a certain cluster size, imagine starting up a three-node cluster in which each node knows that it is going to be part of a three-node cluster. A majority of three nodes is two, so normally the first two nodes to discover each other form a cluster and the third node joins them a short time later. However, imagine that four nodes were erroneously started instead of three. In this case, there are enough nodes to form two separate clusters. Of course if each node is started manually then it’s unlikely that too many nodes are started. If you’re using an automated orchestrator, however, it’s certainly possible to get into this situationparticularly if the orchestrator is not resilient to failures such as network partitions.
6262
::::
6363

6464
The initial quorum is only required the very first time a whole cluster starts up. New nodes joining an established cluster can safely obtain all the information they need from the elected master. Nodes that have previously been part of a cluster will have stored to disk all the information that is required when they restart.

deploy-manage/monitor/autoops/ec-autoops-faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $$$faq-autoops-monitoring$$$Does AutoOps monitor the entire {{stack}}?
2020
: AutoOps is currently limited to {{es}} (not {{kib}}, Logstash and Beats).
2121

2222
$$$faq-autoops-supported-versions$$$What versions of {{es}} are supported for {{ech}}?
23-
: AutoOps supports {es} versions according to the [supported {{stack}} versions](https://www.elastic.co/support/eol).
23+
: AutoOps supports {{es}} versions according to the [supported {{stack}} versions](https://www.elastic.co/support/eol).
2424

2525
$$$faq-autoops-license$$$How is AutoOps currently licensed?
2626
: AutoOps current feature set is available to {{ech}} customers at all subscription tiers. For more information refer to the [subscription page](https://www.elastic.co/subscriptions/cloud).

deploy-manage/monitor/logging-configuration/kib-advanced-logging.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/kibana/current/_cli_configuration.html
44
applies_to:
55
deployment:
6-
self:
6+
self:
77
ece:
88
eck:
99
---
@@ -18,7 +18,7 @@ If you are planning to ingest your logs using {{es}} or another tool, we recomme
1818
You can't configure these settings in an {{ech}} deployment.
1919
:::
2020

21-
The {{kib}} logging system has three main components: *loggers*, *appenders* and *layouts*.
21+
The {{kib}} logging system has three main components: *loggers*, *appenders* and *layouts*.
2222

2323
* **Loggers** define what logging settings should be applied to a particular logger.
2424
* [Appenders](#logging-appenders) define where log messages are displayed (for example, stdout or console) and stored (for example, file on the disk).
@@ -70,7 +70,7 @@ The following conversions are provided out of the box:
7070

7171
* **message**: Outputs the application supplied message associated with the logging event.
7272

73-
* **meta**: Outputs the entries of `meta` object data in ***json** format, if one is present in the event. Example of `%meta` output:
73+
* **meta**: Outputs the entries of `meta` object data in **json** format, if one is present in the event. Example of `%meta` output:
7474

7575
```bash
7676
// Meta{from: 'v7', to: 'v8'}
@@ -391,7 +391,7 @@ logging:
391391
level: debug
392392
```
393393

394-
## Logging configuration using the CLI [logging-cli-migration]
394+
## Logging configuration using the CLI [logging-cli-migration]
395395

396396
You can specify your logging configuration using the CLI. For convenience, the `--verbose` and `--silent` flags exist as shortcuts and will continue to be supported beyond v7.
397397

deploy-manage/remote-clusters/ec-remote-cluster-self-managed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ A deployment can be configured to trust all or specific deployments in any envir
132132
Trust management will not work properly in clusters without an `otherName` value specified, as is the case by default in an out-of-the-box [{{es}} installation](../deploy/self-managed/installing-elasticsearch.md). To have the {{es}} certutil generate new certificates with the `otherName` attribute, use the file input with the `cn` attribute as in the example below.
133133
::::
134134

135-
5. . Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s **Security** page.
135+
5. Provide a name for the trusted environment. That name will appear in the trust summary of your deployment’s **Security** page.
136136
6. Select **Create trust** to complete the configuration.
137137
7. Configure the self-managed cluster to trust this deployment, so that both deployments are configured to trust each other:
138138

0 commit comments

Comments
 (0)