honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 09:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Add X-Pack links to Elasticsearch Reference (#25164)

Browse Source 
* [DOC] Add X-Pack links to Elasticsearch Reference

* [DOCS] Address alignment of attributes in Versions.asciidoc
This commit is contained in:
Lisa Cawley 2017-06-12 13:43:06 -07:00 committed by GitHub
parent 88591fecac
commit 2f7de46b72
6 changed files with 65 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Versions.asciidoc
View File

@ -16,7 +16,7 @@ release-state can be: released | prerelease | unreleased
:painless: https://www.elastic.co/guide/en/elasticsearch/painless/master
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/{branch}
:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/{branch}
:xpack: https://www.elastic.co/guide/en/x-pack/{branch}
:xpack-ref: https://www.elastic.co/guide/en/x-pack/{branch}
:logstash: https://www.elastic.co/guide/en/logstash/{branch}
:kibana: https://www.elastic.co/guide/en/kibana/{branch}
:issue: https://github.com/elastic/elasticsearch/issues/
@ -25,6 +25,13 @@ release-state can be: released | prerelease | unreleased
:docker-image: docker.elastic.co/elasticsearch/elasticsearch:{version}
:plugin_url: https://artifacts.elastic.co/downloads/elasticsearch-plugins
:xpack: X-Pack
:xpackml: X-Pack machine learning
:ml: machine learning
:es: Elasticsearch
:kib: Kibana
:xes-repo-dir: {docdir}/../../elasticsearch-extra/x-pack-elasticsearch/docs/en
///////
Javadoc roots used to generate links from Painless's API reference

6
docs/reference/index-all.asciidoc Normal file
View File

@ -0,0 +1,6 @@
[[elasticsearch-reference]]
= Elasticsearch Reference
:include-xpack: true
include::index-shared.asciidoc[]

45
docs/reference/index-shared.asciidoc Normal file
View File

@ -0,0 +1,45 @@
include::../Versions.asciidoc[]
include::getting-started.asciidoc[]
include::setup.asciidoc[]
include::migration/index.asciidoc[]
include::api-conventions.asciidoc[]
include::docs.asciidoc[]
include::search.asciidoc[]
include::aggregations.asciidoc[]
include::indices.asciidoc[]
include::cat.asciidoc[]
include::cluster.asciidoc[]
include::query-dsl.asciidoc[]
include::mapping.asciidoc[]
include::analysis.asciidoc[]
include::modules.asciidoc[]
include::index-modules.asciidoc[]
include::ingest.asciidoc[]
include::how-to.asciidoc[]
include::testing.asciidoc[]
include::glossary.asciidoc[]
include::release-notes.asciidoc[]
include::redirects.asciidoc[]

45
docs/reference/index.asciidoc
View File

@ -1,47 +1,4 @@
[[elasticsearch-reference]]
= Elasticsearch Reference
include::../Versions.asciidoc[]
include::getting-started.asciidoc[]
include::setup.asciidoc[]
include::migration/index.asciidoc[]
include::api-conventions.asciidoc[]
include::docs.asciidoc[]
include::search.asciidoc[]
include::aggregations.asciidoc[]
include::indices.asciidoc[]
include::cat.asciidoc[]
include::cluster.asciidoc[]
include::query-dsl.asciidoc[]
include::mapping.asciidoc[]
include::analysis.asciidoc[]
include::modules.asciidoc[]
include::index-modules.asciidoc[]
include::ingest.asciidoc[]
include::how-to.asciidoc[]
include::testing.asciidoc[]
include::glossary.asciidoc[]
include::release-notes.asciidoc[]
include::redirects.asciidoc[]
include::index-shared.asciidoc[]

2
docs/reference/setup/install.asciidoc
View File

@ -29,7 +29,7 @@ Elasticsearch website or from our RPM repository.
`docker`::
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.
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.
+
<<docker>>

8
docs/reference/setup/install/docker.asciidoc
View File

@ -2,15 +2,15 @@
=== Install Elasticsearch with Docker
Elasticsearch is also available as a Docker image.
The image is built with {xpack}/index.html[X-Pack] and uses https://hub.docker.com/_/centos/[centos:7] as the base image.
The image is built with {xpack-ref}/index.html[X-Pack] and uses https://hub.docker.com/_/centos/[centos:7] as the base image.
The source code can be found on https://github.com/elastic/elasticsearch-docker/tree/{branch}[GitHub].
==== Security note
NOTE: {xpack}/index.html[X-Pack] is preinstalled in this image.
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`.
NOTE: {xpack-ref}/index.html[X-Pack] is preinstalled in this image.
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`.
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.
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.
Obtaining Elasticsearch for Docker is as simple as issuing a +docker pull+ command against the Elastic Docker registry.