Skip to content

Commit

Permalink
[DOCS] Add index alias definition to glossary (#46339)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Sep 6, 2019
1 parent 4a9e131 commit 023bc30
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 12 deletions.
14 changes: 14 additions & 0 deletions docs/reference/glossary.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ An index is a logical namespace which maps to one or more
<<glossary-primary-shard,primary shards>> and can have zero or more
<<glossary-replica-shard,replica shards>>.

[[glossary-index-alias]] index alias ::
+
--
// tag::index-alias-def[]
An index alias is a secondary name
used to refer to one or more existing indices.

Most {es} APIs accept an index alias
in place of an index name.
// end::index-alias-def[]

See <<indices-add-alias>>.
--

[[glossary-leader-index]] leader index ::

Leader indices are the source indices for <<glossary-ccr,{ccr}>>. They exist
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 @@ -6,7 +6,7 @@

Creates or updates an index alias.

include::alias-exists.asciidoc[tag=index-alias-def]
include::{docdir}/glossary.asciidoc[tag=index-alias-def]

[source,js]
----
Expand Down
9 changes: 1 addition & 8 deletions docs/reference/indices/alias-exists.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@

Checks if an index alias exists.

//tag::index-alias-def[]
An index alias is a secondary name
used to refer to one or more existing indices.
//end::index-alias-def[]

The returned HTTP status code indicates whether the index alias exists or not.
A `404` means it does not exist,
and `200` means it does.
include::{docdir}/glossary.asciidoc[tag=index-alias-def]

[source,js]
----
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 @@ -6,7 +6,7 @@

Adds or removes index aliases.

include::alias-exists.asciidoc[tag=index-alias-def]
include::{docdir}/glossary.asciidoc[tag=index-alias-def]

[source,js]
----
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 @@ -6,7 +6,7 @@

Deletes an existing index alias.

include::alias-exists.asciidoc[tag=index-alias-def]
include::{docdir}/glossary.asciidoc[tag=index-alias-def]

[source,js]
----
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 @@ -6,7 +6,7 @@

Returns information about one or more index aliases.

include::alias-exists.asciidoc[tag=index-alias-def]
include::{docdir}/glossary.asciidoc[tag=index-alias-def]

[source,js]
----
Expand Down

0 comments on commit 023bc30

Please sign in to comment.