[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)

* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
This commit is contained in:
Liam Thompson 2024-04-17 14:37:07 +02:00 committed by GitHub
parent 9b91d9c072
commit 33a71e3289
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
344 changed files with 2331 additions and 2328 deletions

View file

@ -57,7 +57,7 @@ This API deletes a configured collection of
[[ccr-delete-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-delete-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -75,7 +75,7 @@ This API will return the specified auto-follow pattern collection.
[[ccr-get-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-get-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -43,7 +43,7 @@ meantime.
[[ccr-pause-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-pause-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -74,7 +74,7 @@ the new patterns.
[[ccr-put-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-put-auto-follow-pattern-request-body]]
==== {api-request-body-title}

View file

@ -38,7 +38,7 @@ have been deleted or closed in the meantime.
[[ccr-resume-auto-follow-pattern-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-resume-auto-follow-pattern-examples]]
==== {api-examples-title}

View file

@ -52,7 +52,7 @@ replication options and whether the follower indices are active or paused.
[[ccr-get-follow-info-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[role="child_attributes"]
[[ccr-get-follow-info-response-body]]

View file

@ -56,7 +56,7 @@ following task.
[[ccr-post-pause-follow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-pause-follow-examples]]
==== {api-examples-title}

View file

@ -69,7 +69,7 @@ returns, the follower index will resume fetching operations from the leader inde
[[ccr-post-resume-follow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-resume-follow-request-body]]
==== {api-request-body-title}

View file

@ -63,7 +63,7 @@ irreversible operation.
[[ccr-post-unfollow-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-post-unfollow-examples]]
==== {api-examples-title}

View file

@ -65,7 +65,7 @@ referenced leader index. When this API returns, the follower index exists, and
follower shard requires transferring all the remote Lucene segment files to
the follower index.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[[ccr-put-follow-request-body]]
==== {api-request-body-title}

View file

@ -56,7 +56,7 @@ shard-level stats as in the <<ccr-get-follow-stats,get follower stats API>>.
`timeout`::
(Optional, time) Controls the amount of time to wait for results. Defaults to unlimited.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
[role="child_attributes"]
[[ccr-get-stats-response-body]]

View file

@ -159,7 +159,7 @@ cluster with cluster alias `leader`.
connected to.
====
include::{es-repo-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges]
include::{es-ref-dir}/security/authentication/remote-clusters-privileges-cert.asciidoc[tag=configure-ccr-privileges]
[[ccr-getting-started-follower-index]]
==== Create a follower index to replicate a specific index