Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Sep 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/alias.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[chapter]
[[alias]]
[[aliases]]
= Aliases

An alias is a secondary name for a group of data streams or indices. Most {es}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/actions/ilm-rollover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/index-rollover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/add-alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/alias-exists.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Alias exists</titleabbrev>
++++

Checks if an <<alias,alias>> exists.
Checks if an <<aliases,alias>> exists.

[source,console]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/aliases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/create-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ include_type_name is set. For more details, please see <<removal-of-types>>.
[[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]
--------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/delete-alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/delete-index-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/delete-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>.

To delete all indices, use `_all` or `*` . To disallow the deletion of indices
with `_all` or wildcard expressions, change the
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/get-alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/index-template-exists-v1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/migrate-to-data-stream.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/indices/put-component-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------
Expand Down Expand Up @@ -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]
--------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/put-index-template-v1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
--------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/indices/put-index-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
--------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/indices/rollover-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
9 changes: 8 additions & 1 deletion docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@

The following pages have moved or been deleted.

[role="exclude",id="alias"]
=== Aliases

For field aliases, refer to the <<field-alias,alias field type>>.

For index and data stream aliases, refer to <<aliases>>.

[role="exclude",id="modules-scripting-other-layers"]
=== Other security layers

Expand Down Expand Up @@ -404,7 +411,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"]
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,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`.
Expand Down Expand Up @@ -602,13 +602,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[]

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/search/multi-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 closed index.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down