[DOCS] Move snapshot-restore out of modules. (elastic#49618)

* [DOCS] Move snapshot-restore docs out of modules. * [DOCS] Incorporates comments from @jrodewig. * [DOCS] Fix snippet tests
debadair · Jan 10, 2020 · 021236a · 021236a
1 parent 4af1ed5
commit 021236a
Show file tree

Hide file tree

Showing 15 changed files with 906 additions and 802 deletions.
diff --git a/docs/reference/glossary.asciidoc b/docs/reference/glossary.asciidoc
@@ -181,7 +181,7 @@ during the following processes:
   This type of recovery is called a *local store recovery*.
 * <<glossary-replica-shard,Primary shard replication>>.
 * Relocation of a shard to a different node in the same cluster.
-* {ref}/modules-snapshots.html#restore-snapshot[Snapshot restoration].
+* {ref}/snapshots-restore-snapshot.html[Snapshot restoration].
 // end::recovery-triggers[]
 --
 

diff --git a/docs/reference/high-availability/backup-cluster-data.asciidoc b/docs/reference/high-availability/backup-cluster-data.asciidoc
@@ -6,7 +6,7 @@
 
 To back up your cluster's data, you can use the <<modules-snapshots,snapshot API>>.
 
-include::{es-repo-dir}/modules/snapshots.asciidoc[tag=snapshot-intro]
+include::../snapshot-restore/index.asciidoc[tag=snapshot-intro]
 
 [TIP]
 ====

diff --git a/docs/reference/high-availability/backup-cluster.asciidoc b/docs/reference/high-availability/backup-cluster.asciidoc
@@ -1,7 +1,7 @@
 [[backup-cluster]]
 == Back up a cluster
 
-include::{es-repo-dir}/modules/snapshots.asciidoc[tag=backup-warning]
+include::../snapshot-restore/index.asciidoc[tag=backup-warning]
 
 To have a complete backup for your cluster:
 

diff --git a/docs/reference/high-availability/restore-cluster-data.asciidoc b/docs/reference/high-availability/restore-cluster-data.asciidoc
@@ -4,7 +4,7 @@
 <titleabbrev>Restore the data</titleabbrev>
 ++++
 
-include::{es-repo-dir}/modules/snapshots.asciidoc[tag=restore-intro]
+include::../snapshot-restore/index.asciidoc[tag=restore-intro]
 
 [TIP]
 ====

diff --git a/docs/reference/ilm/getting-started-slm.asciidoc b/docs/reference/ilm/getting-started-slm.asciidoc
@@ -5,7 +5,7 @@
 
 Let's get started with snapshot lifecycle management (SLM) by working through a
 hands-on scenario. The goal of this example is to automatically back up {es}
-indices using the <<modules-snapshots,snapshots>> every day at a particular
+indices using the <<snapshot-restore,snapshots>> every day at a particular
 time. Once these snapshots have been created, they are kept for a configured
 amount of time and then deleted per a configured retention policy.
 
@@ -59,7 +59,7 @@ POST /_security/role/slm-read-only
 === Setting up a repository
 
 Before we can set up an SLM policy, we'll need to set up a
-<<snapshots-repositories,snapshot repository>> where the snapshots will be
+snapshot repository where the snapshots will be
 stored. Repositories can use {plugins}/repository.html[many different backends],
 including cloud storage providers. You'll probably want to use one of these in
 production, but for this example we'll use a shared file system repository:

diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc
@@ -54,6 +54,8 @@ include::data-rollup-transform.asciidoc[]
 
 include::high-availability.asciidoc[]
 
+include::snapshot-restore/index.asciidoc[]
+
 include::{xes-repo-dir}/security/index.asciidoc[]
 
 include::{xes-repo-dir}/watcher/index.asciidoc[]

diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc
@@ -77,7 +77,7 @@ This type of recovery is called a local store recovery.
 
 `SNAPSHOT`::
 The recovery is related to
-a <<restore-snapshot,snapshot restoration>>.
+a <<snapshots-restore-snapshot,snapshot restoration>>.
 
 `REPLICA`::
 The recovery is related to

diff --git a/docs/reference/modules.asciidoc b/docs/reference/modules.asciidoc
@@ -91,8 +91,6 @@ include::modules/node.asciidoc[]
 
 include::modules/plugins.asciidoc[]
 
-include::modules/snapshots.asciidoc[]
-
 include::modules/threadpool.asciidoc[]
 
 include::modules/transport.asciidoc[]