From 22508c63de346fb4b9fd44712aa08d708151608b Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 11 Jan 2021 12:59:05 -0500 Subject: [PATCH] [DOCS] Clean up index template xrefs (#67264) (#67274) --- docs/reference/analysis/specify-analyzer.asciidoc | 2 +- docs/reference/cat/templates.asciidoc | 2 +- .../data-streams/change-mappings-and-settings.asciidoc | 10 +++++----- docs/reference/data-streams/data-streams.asciidoc | 4 ++-- docs/reference/docs/index_.asciidoc | 2 +- docs/reference/glossary.asciidoc | 2 +- .../high-availability/cluster-design.asciidoc | 2 +- docs/reference/ilm/actions/ilm-allocate.asciidoc | 2 +- docs/reference/ilm/actions/ilm-migrate.asciidoc | 2 +- docs/reference/ilm/ilm-tutorial.asciidoc | 2 +- docs/reference/ilm/index-rollover.asciidoc | 2 +- docs/reference/ilm/set-up-lifecycle-policy.asciidoc | 2 +- docs/reference/indices.asciidoc | 2 +- docs/reference/indices/create-data-stream.asciidoc | 2 +- .../indices/delete-component-template.asciidoc | 2 +- docs/reference/indices/put-component-template.asciidoc | 2 +- docs/reference/indices/rollover-index.asciidoc | 2 +- docs/reference/indices/simulate-index.asciidoc | 2 +- docs/reference/indices/simulate-template.asciidoc | 2 +- docs/reference/mapping/dynamic-mapping.asciidoc | 2 +- docs/reference/monitoring/indices.asciidoc | 2 +- 21 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/reference/analysis/specify-analyzer.asciidoc b/docs/reference/analysis/specify-analyzer.asciidoc index 9a7d66a9463..d3114a74984 100644 --- a/docs/reference/analysis/specify-analyzer.asciidoc +++ b/docs/reference/analysis/specify-analyzer.asciidoc @@ -20,7 +20,7 @@ analyzer for indexing and search. It also lets you quickly see which analyzer applies to which field using the <>. If you don't typically create mappings for your indices, you can use -<> to achieve a similar effect. +<> to achieve a similar effect. ==== [[specify-index-time-analyzer]] diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index fc6b61fa821..00d92b87e8d 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -4,7 +4,7 @@ cat templates ++++ -Returns information about <> in a cluster. +Returns information about <> in a cluster. You can use index templates to apply <> and <> to new indices at creation. diff --git a/docs/reference/data-streams/change-mappings-and-settings.asciidoc b/docs/reference/data-streams/change-mappings-and-settings.asciidoc index ddfada9a672..fb828b5a770 100644 --- a/docs/reference/data-streams/change-mappings-and-settings.asciidoc +++ b/docs/reference/data-streams/change-mappings-and-settings.asciidoc @@ -93,7 +93,7 @@ field mapping is added to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request adds a mapping +The following <> request adds a mapping for a new field, `message`, to the template. [source,console] @@ -175,7 +175,7 @@ field mapping is added to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request changes the +The following <> request changes the argument for the `host.ip` field's <> mapping parameter to `true`. @@ -281,7 +281,7 @@ applied to future backing indices created for the stream. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request changes the +The following <> request changes the template's `index.refresh_interval` index setting to `30s` (30 seconds). [source,console] @@ -335,7 +335,7 @@ backing index created after the update. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> requests adds new +The following <> requests adds new `sort.field` and `sort.order index` settings to the template. [source,console] @@ -428,7 +428,7 @@ new template by copying an existing one and modifying it as needed. For example, `my-data-stream-template` is an existing index template used by `my-data-stream`. -The following <> request creates a new +The following <> request creates a new index template, `new-data-stream-template`. `new-data-stream-template` uses `my-data-stream-template` as its basis, with the following changes: diff --git a/docs/reference/data-streams/data-streams.asciidoc b/docs/reference/data-streams/data-streams.asciidoc index c6cb8ee3e48..96e7ab26f72 100644 --- a/docs/reference/data-streams/data-streams.asciidoc +++ b/docs/reference/data-streams/data-streams.asciidoc @@ -27,7 +27,7 @@ backing indices. image::images/data-streams/data-streams-diagram.svg[align="center"] -Each data stream requires a matching <>. The +Each data stream requires a matching <>. The template contains the mappings and settings used to configure the stream's backing indices. @@ -122,7 +122,7 @@ If needed, you can <> by submitting requests directly to the document's backing index. TIP: If you frequently update or delete existing documents, use an -<> and <> +<> and <> instead of a data stream. You can still use <> to manage indices for the alias. diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index c482b9ddaae..acd70629a4d 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -180,7 +180,7 @@ definition>>, the index operation automatically creates the data stream. See If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching -<>. +<>. [IMPORTANT] ==== diff --git a/docs/reference/glossary.asciidoc b/docs/reference/glossary.asciidoc index 0ed0ef3c268..1d9852720eb 100644 --- a/docs/reference/glossary.asciidoc +++ b/docs/reference/glossary.asciidoc @@ -61,7 +61,7 @@ that is accessed occasionally and not normally updated. [[glossary-component-template]] component template :: // tag::component-template-def[] -A building block for constructing <> that specifies index +A building block for constructing <> that specifies index <>, <>, and <>. // end::component-template-def[] diff --git a/docs/reference/high-availability/cluster-design.asciidoc b/docs/reference/high-availability/cluster-design.asciidoc index 88dea56df89..914db1a1d1f 100644 --- a/docs/reference/high-availability/cluster-design.asciidoc +++ b/docs/reference/high-availability/cluster-design.asciidoc @@ -80,7 +80,7 @@ If you have two nodes, we recommend they both be data nodes. You should also ensure every shard is stored redundantly on both nodes by setting <> to `1` on every index. This is the default number of replicas but may be overridden by an -<>. <>. <> can also achieve the same thing, but it's not necessary to use this feature in such a small cluster. diff --git a/docs/reference/ilm/actions/ilm-allocate.asciidoc b/docs/reference/ilm/actions/ilm-allocate.asciidoc index aacecdc5aaa..1dd181ebc44 100644 --- a/docs/reference/ilm/actions/ilm-allocate.asciidoc +++ b/docs/reference/ilm/actions/ilm-allocate.asciidoc @@ -9,7 +9,7 @@ and change the number of replicas. The allocate action is not allowed in the hot phase. The initial allocation for the index must be done manually or via -<>. +<>. You can configure this action to modify both the allocation rules and number of replicas, only the allocation rules, or only the number of replicas. diff --git a/docs/reference/ilm/actions/ilm-migrate.asciidoc b/docs/reference/ilm/actions/ilm-migrate.asciidoc index c8e840e3017..b829aa68341 100644 --- a/docs/reference/ilm/actions/ilm-migrate.asciidoc +++ b/docs/reference/ilm/actions/ilm-migrate.asciidoc @@ -27,7 +27,7 @@ to `data_cold,data_warm,data_hot`. This moves the index to nodes in the The migrate action is not allowed in the hot phase. The initial index allocation is performed <>, -and can be configured manually or via <>. +and can be configured manually or via <>. [[ilm-migrate-options]] ==== Options diff --git a/docs/reference/ilm/ilm-tutorial.asciidoc b/docs/reference/ilm/ilm-tutorial.asciidoc index d5a4252e5cb..3b290ac8d70 100644 --- a/docs/reference/ilm/ilm-tutorial.asciidoc +++ b/docs/reference/ilm/ilm-tutorial.asciidoc @@ -148,7 +148,7 @@ PUT _index_template/timeseries_template === Create the data stream To get things started, index a document into the name or wildcard pattern defined -in the `index_patterns` of the <>. As long +in the `index_patterns` of the <>. As long as an existing data stream, index, or index alias does not already use the name, the index request automatically creates a corresponding data stream with a single backing index. {es} automatically indexes the request's documents into this backing index, which also diff --git a/docs/reference/ilm/index-rollover.asciidoc b/docs/reference/ilm/index-rollover.asciidoc index 36c61d0559c..42350ed13c9 100644 --- a/docs/reference/ilm/index-rollover.asciidoc +++ b/docs/reference/ilm/index-rollover.asciidoc @@ -15,7 +15,7 @@ Using rolling indices enables you to: We recommend using <> to manage time series data. Data streams automatically track the write index while keeping configuration to a minimum. -Each data stream requires an <> that contains: +Each data stream requires an <> that contains: * A name or wildcard (`*`) pattern for the data stream. diff --git a/docs/reference/ilm/set-up-lifecycle-policy.asciidoc b/docs/reference/ilm/set-up-lifecycle-policy.asciidoc index 803b295bacb..667864c3c7e 100644 --- a/docs/reference/ilm/set-up-lifecycle-policy.asciidoc +++ b/docs/reference/ilm/set-up-lifecycle-policy.asciidoc @@ -7,7 +7,7 @@ For {ilm-init} to manage an index, a valid policy must be specified in the `index.lifecycle.name` index setting. To configure a lifecycle policy for <>, -you create the policy and add it to the <>. +you create the policy and add it to the <>. To use a policy to manage an index that doesn't roll over, you can specify a lifecycle policy when you create the index, diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index 38728a59927..1db026b2cca 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -56,7 +56,7 @@ Index templates automatically apply settings, mappings, and aliases to new indic They are most often used to configure rolling indices for time series data to ensure that each new index has the same configuration as the previous one. The index template associated with a data stream configures its backing indices. -For more information, see <>. +For more information, see <>. * <> * <> diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index d7da6c95d7d..d4de016686b 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -7,7 +7,7 @@ Creates a new <>. -Data streams require a matching <>. +Data streams require a matching <>. See <>. //// diff --git a/docs/reference/indices/delete-component-template.asciidoc b/docs/reference/indices/delete-component-template.asciidoc index 5b69eac04fd..e559ddc3911 100644 --- a/docs/reference/indices/delete-component-template.asciidoc +++ b/docs/reference/indices/delete-component-template.asciidoc @@ -37,7 +37,7 @@ DELETE _component_template/template_1 ==== {api-description-title} Use the delete component template API to delete one or more component templates -Component templates are building blocks for constructing <> +Component templates are building blocks for constructing <> that specify index mappings, settings, and aliases. [[delete-component-template-api-path-params]] diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index dfaeb874746..79930a8a99e 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -5,7 +5,7 @@ ++++ Creates or updates a component template. -Component templates are building blocks for constructing <> +Component templates are building blocks for constructing <> that specify index <>, <>, and <>. diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index 0a70c5f79d3..55270a4f237 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -304,7 +304,7 @@ DELETE /_index_template/template ===== Specify settings for the target index The settings, mappings, and aliases for the new index are taken from any -matching <>. If the rollover target is an +matching <>. If the rollover target is an index alias, you can specify `settings`, `mappings`, and `aliases` in the body of the request just like the <> API. Values specified in the request override any values set in matching index templates. diff --git a/docs/reference/indices/simulate-index.asciidoc b/docs/reference/indices/simulate-index.asciidoc index efdf78126da..2d09117be40 100644 --- a/docs/reference/indices/simulate-index.asciidoc +++ b/docs/reference/indices/simulate-index.asciidoc @@ -7,7 +7,7 @@ experimental[] Returns the index configuration that would be applied to the specified index from an -existing <>. +existing <>. //// [source,console] diff --git a/docs/reference/indices/simulate-template.asciidoc b/docs/reference/indices/simulate-template.asciidoc index 6d58ad2ef6f..860df49c139 100644 --- a/docs/reference/indices/simulate-template.asciidoc +++ b/docs/reference/indices/simulate-template.asciidoc @@ -7,7 +7,7 @@ experimental[] Returns the index configuration that would be applied by a particular -<>. +<>. //// [source,console] diff --git a/docs/reference/mapping/dynamic-mapping.asciidoc b/docs/reference/mapping/dynamic-mapping.asciidoc index e62f243b669..54d373e1e29 100644 --- a/docs/reference/mapping/dynamic-mapping.asciidoc +++ b/docs/reference/mapping/dynamic-mapping.asciidoc @@ -28,7 +28,7 @@ purposes with: Custom rules to configure the mapping for dynamically added fields. -TIP: <> allow you to configure the default +TIP: <> allow you to configure the default mappings, settings and aliases for new indices, whether created automatically or explicitly. diff --git a/docs/reference/monitoring/indices.asciidoc b/docs/reference/monitoring/indices.asciidoc index c0c001dbc46..3a7288aa15f 100644 --- a/docs/reference/monitoring/indices.asciidoc +++ b/docs/reference/monitoring/indices.asciidoc @@ -3,7 +3,7 @@ [[config-monitoring-indices]] == Configuring indices for monitoring -<> are used to configure the indices +<> are used to configure the indices that store the monitoring data collected from a cluster. You can retrieve the templates through the `_template` API: