Przeglądaj źródła

[DOCS] Update anchor and add redirect for aliases (#77349)

PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
James Rodewig 4 lat temu
rodzic
commit
cfae69717a

+ 1 - 1
docs/reference/alias.asciidoc

@@ -1,5 +1,5 @@
 [chapter]
-[[alias]]
+[[aliases]]
 = Aliases
 
 An alias is a secondary name for a group of data streams or indices. Most {es}

+ 1 - 1
docs/reference/cat/alias.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>cat aliases</titleabbrev>
 ++++
 
-Retrieves the cluster's <<alias,index aliases>>, including filter and routing
+Retrieves the cluster's <<aliases,index aliases>>, including filter and routing
 information. The API does not return data stream aliases.
 
 [[cat-alias-api-request]]

+ 1 - 1
docs/reference/ilm/actions/ilm-rollover.asciidoc

@@ -12,7 +12,7 @@ policy execution waits until the leader index rolls over (or is
 then converts the follower index into a regular index with the
 <<ilm-unfollow, Unfollow action>>.
 
-A rollover target can be a <<data-streams, data stream>> or an <<alias,index
+A rollover target can be a <<data-streams, data stream>> or an <<aliases,index
 alias>>. When targeting a data stream, the new index becomes the data stream's
 write index and its generation is incremented.
 

+ 1 - 1
docs/reference/ilm/index-rollover.asciidoc

@@ -28,7 +28,7 @@ Each data stream requires an <<index-templates,index template>> that contains:
 Data streams are designed for append-only data, where the data stream name
 can be used as the operations (read, write, rollover, shrink etc.) target.
 If your use case requires data to be updated in place, you can instead manage
-your time series data using <<alias,index aliases>>. However, there are a few
+your time series data using <<aliases,index aliases>>. However, there are a few
 more configuration steps and concepts:
 
 * An _index template_ that specifies the settings for each new index in the series.

+ 1 - 1
docs/reference/indices/add-alias.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Create or update alias</titleabbrev>
 ++++
 
-Adds a data stream or index to an <<alias,alias>>.
+Adds a data stream or index to an <<aliases,alias>>.
 
 [source,console]
 ----

+ 1 - 1
docs/reference/indices/alias-exists.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Alias exists</titleabbrev>
 ++++
 
-Checks if an <<alias,alias>> exists.
+Checks if an <<aliases,alias>> exists.
 
 [source,console]
 ----

+ 1 - 1
docs/reference/indices/aliases.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Aliases</titleabbrev>
 ++++
 
-Performs one or more <<alias,alias>> actions in a single atomic operation.
+Performs one or more <<aliases,alias>> actions in a single atomic operation.
 
 [source,console]
 ----

+ 1 - 1
docs/reference/indices/create-index.asciidoc

@@ -186,7 +186,7 @@ PUT /test
 [[create-index-aliases]]
 ===== Aliases
 
-The create index API allows also to provide a set of <<alias,aliases>>:
+The create index API allows also to provide a set of <<aliases,aliases>>:
 
 [source,console]
 --------------------------------------------------

+ 1 - 1
docs/reference/indices/delete-alias.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Delete alias</titleabbrev>
 ++++
 
-Removes a data stream or index from an <<alias,alias>>.
+Removes a data stream or index from an <<aliases,alias>>.
 
 [source,console]
 ----

+ 1 - 1
docs/reference/indices/delete-index-template.asciidoc

@@ -49,7 +49,7 @@ privilege>> to use this API.
 
 Use the delete index template API to delete one or more index templates.
 Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>,
-and <<alias,aliases>> that can be applied automatically to new indices.
+and <<aliases,aliases>> that can be applied automatically to new indices.
 
 
 [[delete-template-api-path-params]]

+ 1 - 1
docs/reference/indices/delete-index.asciidoc

@@ -31,7 +31,7 @@ or `manage` <<privileges-list-indices,index privilege>> for the target index.
 +
 --
 (Required, string) Comma-separated list of indices to delete. You cannot specify
-<<alias,index aliases>>.
+<<aliases,index aliases>>.
 
 By default, this parameter does not support wildcards (`*`) or `_all`. To use
 wildcards or `_all`, change the `action.destructive_requires_name` setting to

+ 1 - 1
docs/reference/indices/get-alias.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Get alias</titleabbrev>
 ++++
 
-Retrieves information for one or more <<alias,aliases>>.
+Retrieves information for one or more <<aliases,aliases>>.
 
 [source,console]
 ----

+ 1 - 1
docs/reference/indices/index-template-exists-v1.asciidoc

@@ -38,7 +38,7 @@ Use the index template exists API
 to determine whether one or more index templates exist.
 
 Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>, 
-and <<alias,aliases>> that can be applied automatically to new indices. 
+and <<aliases,aliases>> that can be applied automatically to new indices. 
 
 [[template-exists-api-path-params]]
 ==== {api-path-parms-title}

+ 1 - 1
docs/reference/indices/migrate-to-data-stream.asciidoc

@@ -5,7 +5,7 @@
 <titleabbrev>Migrate to data stream</titleabbrev>
 ++++
 
-Converts an <<alias,index alias>> to a <<data-streams,data stream>>.
+Converts an <<aliases,index alias>> to a <<data-streams,data stream>>.
 
 ////
 [source,console]

+ 2 - 2
docs/reference/indices/put-component-template.asciidoc

@@ -7,7 +7,7 @@
 Creates or updates a component template. Component templates are building blocks
 for constructing <<index-templates,index templates>> that specify index
 <<mapping,mappings>>, <<index-modules-settings,settings>>, and
-<<alias,aliases>>.
+<<aliases,aliases>>.
 
 [source,console]
 --------------------------------------------------
@@ -168,7 +168,7 @@ This map is not automatically generated by {es}.
 
 ===== Component template with index aliases
 
-You can include <<alias,index aliases>> in a component template.
+You can include <<aliases,index aliases>> in a component template.
 
 [source,console]
 --------------------------------------------------

+ 1 - 1
docs/reference/indices/put-index-template-v1.asciidoc

@@ -143,7 +143,7 @@ This number is not automatically generated by {es}.
 
 ===== Index template with index aliases
 
-You can include <<alias,index aliases>> in an index template.
+You can include <<aliases,index aliases>> in an index template.
 
 [source,console]
 --------------------------------------------------

+ 2 - 2
docs/reference/indices/put-index-template.asciidoc

@@ -5,7 +5,7 @@
 ++++
 
 Creates or updates an index template. Index templates define
-<<index-modules-settings,settings>>, <<mapping,mappings>>, and <<alias,aliases>>
+<<index-modules-settings,settings>>, <<mapping,mappings>>, and <<aliases,aliases>>
 that can be applied automatically to new indices. 
 
 [source,console]
@@ -163,7 +163,7 @@ This number is not automatically generated by {es}.
 
 ===== Index template with index aliases
 
-You can include <<alias,index aliases>> in an index template.
+You can include <<aliases,index aliases>> in an index template.
 
 [source,console]
 --------------------------------------------------

+ 1 - 1
docs/reference/indices/rollover-index.asciidoc

@@ -4,7 +4,7 @@
 <titleabbrev>Rollover</titleabbrev>
 ++++
 
-Creates a new index for a <<data-streams,data stream>> or <<alias,index alias>>.
+Creates a new index for a <<data-streams,data stream>> or <<aliases,index alias>>.
 
 [source,console]
 ----

+ 8 - 1
docs/reference/redirects.asciidoc

@@ -3,6 +3,13 @@
 
 The following pages have moved or been deleted.
 
+[role="exclude",id="alias"]
+=== Aliases
+
+For field aliases, refer to <<field-alias>>.
+
+For index and data stream aliases, refer to <<aliases>>.
+
 [role="exclude",id="modules-scripting-other-layers"]
 === Other security layers
 
@@ -416,7 +423,7 @@ See <<getting-started-index>>.
 See <<indices-delete-index>>.
 
 [role="exclude", id="getting-started-modify-data"]
-== Modifying your data
+=== Modifying your data
 See <<docs-update>>.
 
 [role="exclude", id="indexing-replacing-documents"]

+ 3 - 3
docs/reference/rest-api/common-parms.asciidoc

@@ -22,7 +22,7 @@ tag::allow-no-indices[]
 `allow_no_indices`::
 (Optional, Boolean)
 If `false`, the request returns an error if any wildcard expression,
-<<alias,index alias>>, or `_all` value targets only missing or closed indices.
+<<aliases,index alias>>, or `_all` value targets only missing or closed indices.
 This behavior applies even if the request targets other open indices. For
 example, a request targeting `foo*,bar*` returns an error if an index starts
 with `foo` but no index starts with `bar`.
@@ -588,13 +588,13 @@ end::memory[]
 tag::bulk-require-alias[]
 `require_alias`::
 (Optional, Boolean)
-If `true`, the action must target an <<alias,index alias>>. Defaults to
+If `true`, the action must target an <<aliases,index alias>>. Defaults to
 `false`.
 end::bulk-require-alias[]
 
 tag::require-alias[]
 `require_alias`::
-(Optional, Boolean) If `true`, the destination must be an <<alias,index alias>>.
+(Optional, Boolean) If `true`, the destination must be an <<aliases,index alias>>.
 Defaults to `false`.
 end::require-alias[]
 

+ 1 - 1
docs/reference/search/multi-search.asciidoc

@@ -184,7 +184,7 @@ line.
 If `true`, the request does *not* return an error if a wildcard expression or
 `_all` value retrieves only missing or closed indices.
 +
-This parameter also applies to <<alias,aliases>> that point to a missing
+This parameter also applies to <<aliases,aliases>> that point to a missing
 or index.
 
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]

+ 2 - 2
x-pack/docs/en/security/authorization/alias-privileges.asciidoc

@@ -3,7 +3,7 @@
 === Granting privileges for data streams and aliases
 
 {es} {security-features} allow you to secure operations executed against
-<<data-streams,data streams>> and <<alias,aliases>>.
+<<data-streams,data streams>> and <<aliases,aliases>>.
 
 [[data-stream-privileges]]
 ==== Data stream privileges
@@ -66,7 +66,7 @@ GET .ds-my-data-stream-2099.03.09-000003/_doc/2
 ==== Alias privileges
 
 Use <<privileges-list-indices,index privileges>> to control access to an
-<<alias,alias>>. Privileges on an index or data stream do not grant privileges
+<<aliases,alias>>. Privileges on an index or data stream do not grant privileges
 on its aliases. For information about managing aliases, see <<alias>>.
 
 IMPORTANT: Don't use <<filter-alias,filtered aliases>> in place of

+ 1 - 1
x-pack/docs/en/watcher/example-watches/example-watch-meetupdata.asciidoc

@@ -145,7 +145,7 @@ To set up the watch:
   },
 -------------------------------------------------
 // NOTCONSOLE
-<1> `logstash` is the default <<alias,index alias>> for the {ls} indices
+<1> `logstash` is the default <<aliases,index alias>> for the {ls} indices
 containing the meetup data. By default, the {ls}
 <<index-lifecycle-management,{ilm} ({ilm-init})>> policy rolls this alias to a
 new index when the index size reaches 50GB or becomes 30 days old. For more