Skip to content

Commit 2f7de46

Browse files
lcawllcawl
authored
[DOC] Add X-Pack links to Elasticsearch Reference (#25164)
* [DOC] Add X-Pack links to Elasticsearch Reference * [DOCS] Address alignment of attributes in Versions.asciidoc
1 parent 88591fe commit 2f7de46

File tree

6 files changed

+65
-50
lines changed

6 files changed

+65
-50
lines changed

‎docs/Versions.asciidoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ release-state can be: released | prerelease | unreleased
1616
:painless: https://www.elastic.co/guide/en/elasticsearch/painless/master
1717
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/{branch}
1818
:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/{branch}
19-
:xpack: https://www.elastic.co/guide/en/x-pack/{branch}
19+
:xpack-ref: https://www.elastic.co/guide/en/x-pack/{branch}
2020
:logstash: https://www.elastic.co/guide/en/logstash/{branch}
2121
:kibana: https://www.elastic.co/guide/en/kibana/{branch}
2222
:issue: https://github.com/elastic/elasticsearch/issues/
@@ -25,6 +25,13 @@ release-state can be: released | prerelease | unreleased
2525
:docker-image: docker.elastic.co/elasticsearch/elasticsearch:{version}
2626
:plugin_url: https://artifacts.elastic.co/downloads/elasticsearch-plugins
2727

28+
:xpack: X-Pack
29+
:xpackml: X-Pack machine learning
30+
:ml: machine learning
31+
:es: Elasticsearch
32+
:kib: Kibana
33+
34+
:xes-repo-dir: {docdir}/../../elasticsearch-extra/x-pack-elasticsearch/docs/en
2835

2936
///////
3037
Javadoc roots used to generate links from Painless's API reference

‎docs/reference/index-all.asciidoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[[elasticsearch-reference]]
2+
= Elasticsearch Reference
3+
4+
:include-xpack: true
5+
6+
include::index-shared.asciidoc[]

‎docs/reference/index-shared.asciidoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
include::../Versions.asciidoc[]
3+
4+
5+
include::getting-started.asciidoc[]
6+
7+
include::setup.asciidoc[]
8+
9+
include::migration/index.asciidoc[]
10+
11+
include::api-conventions.asciidoc[]
12+
13+
include::docs.asciidoc[]
14+
15+
include::search.asciidoc[]
16+
17+
include::aggregations.asciidoc[]
18+
19+
include::indices.asciidoc[]
20+
21+
include::cat.asciidoc[]
22+
23+
include::cluster.asciidoc[]
24+
25+
include::query-dsl.asciidoc[]
26+
27+
include::mapping.asciidoc[]
28+
29+
include::analysis.asciidoc[]
30+
31+
include::modules.asciidoc[]
32+
33+
include::index-modules.asciidoc[]
34+
35+
include::ingest.asciidoc[]
36+
37+
include::how-to.asciidoc[]
38+
39+
include::testing.asciidoc[]
40+
41+
include::glossary.asciidoc[]
42+
43+
include::release-notes.asciidoc[]
44+
45+
include::redirects.asciidoc[]

‎docs/reference/index.asciidoc‎

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,4 @@
11
[[elasticsearch-reference]]
22
= Elasticsearch Reference
33

4-
include::../Versions.asciidoc[]
5-
6-
7-
include::getting-started.asciidoc[]
8-
9-
include::setup.asciidoc[]
10-
11-
include::migration/index.asciidoc[]
12-
13-
include::api-conventions.asciidoc[]
14-
15-
include::docs.asciidoc[]
16-
17-
include::search.asciidoc[]
18-
19-
include::aggregations.asciidoc[]
20-
21-
include::indices.asciidoc[]
22-
23-
include::cat.asciidoc[]
24-
25-
include::cluster.asciidoc[]
26-
27-
include::query-dsl.asciidoc[]
28-
29-
include::mapping.asciidoc[]
30-
31-
include::analysis.asciidoc[]
32-
33-
include::modules.asciidoc[]
34-
35-
include::index-modules.asciidoc[]
36-
37-
include::ingest.asciidoc[]
38-
39-
include::how-to.asciidoc[]
40-
41-
include::testing.asciidoc[]
42-
43-
include::glossary.asciidoc[]
44-
45-
include::release-notes.asciidoc[]
46-
47-
include::redirects.asciidoc[]
4+
include::index-shared.asciidoc[]

‎docs/reference/setup/install.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Elasticsearch website or from our RPM repository.
2929

3030
`docker`::
3131

32-
An image is available for running Elasticsearch as a Docker container. It ships with {xpack}/index.html[X-Pack] pre-installed and may be downloaded from the Elastic Docker Registry.
32+
An image is available for running Elasticsearch as a Docker container. It ships with {xpack-ref}/index.html[X-Pack] pre-installed and may be downloaded from the Elastic Docker Registry.
3333
+
3434
<<docker>>
3535

‎docs/reference/setup/install/docker.asciidoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
=== Install Elasticsearch with Docker
33

44
Elasticsearch is also available as a Docker image.
5-
The image is built with {xpack}/index.html[X-Pack] and uses https://hub.docker.com/_/centos/[centos:7] as the base image.
5+
The image is built with {xpack-ref}/index.html[X-Pack] and uses https://hub.docker.com/_/centos/[centos:7] as the base image.
66
The source code can be found on https://github.com/elastic/elasticsearch-docker/tree/{branch}[GitHub].
77

88
==== Security note
99

10-
NOTE: {xpack}/index.html[X-Pack] is preinstalled in this image.
11-
Please take a few minutes to familiarize yourself with {xpack}/security-getting-started.html[X-Pack Security] and how to change default passwords. The default password for the `elastic` user is `changeme`.
10+
NOTE: {xpack-ref}/index.html[X-Pack] is preinstalled in this image.
11+
Please take a few minutes to familiarize yourself with {xpack-ref}/security-getting-started.html[X-Pack Security] and how to change default passwords. The default password for the `elastic` user is `changeme`.
1212

13-
NOTE: X-Pack includes a trial license for 30 days. After that, you can obtain one of the https://www.elastic.co/subscriptions[available subscriptions] or {xpack}/security-settings.html[disable Security]. The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.
13+
NOTE: X-Pack includes a trial license for 30 days. After that, you can obtain one of the https://www.elastic.co/subscriptions[available subscriptions] or {xpack-ref}/security-settings.html[disable Security]. The Basic license is free and includes the https://www.elastic.co/products/x-pack/monitoring[Monitoring] extension.
1414

1515
Obtaining Elasticsearch for Docker is as simple as issuing a +docker pull+ command against the Elastic Docker registry.
1616

0 commit comments

Comments
 (0)