Centralised doc versions in docs/Versions.asciidoc

This commit is contained in:
Clinton Gormley 2017-02-04 11:16:19 +01:00
parent 796087a5a9
commit c1be26f2e1
6 changed files with 52 additions and 50 deletions

43
docs/Versions.asciidoc Normal file
View File

@ -0,0 +1,43 @@
:version: 6.0.0-alpha1
:major-version: 6.x
:lucene_version: 6.4.0
:lucene_version_path: 6_4_0
:branch: master
:jdk: 1.8.0_73
//////////
release-state can be: released | prerelease | unreleased
//////////
:release-state: unreleased
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch}
:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/{branch}
: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/5.0
:issue: https://github.com/elastic/elasticsearch/issues/
:pull: https://github.com/elastic/elasticsearch/pull/
:docker-image: docker.elastic.co/elasticsearch/elasticsearch:{version}
:plugin_url: https://artifacts.elastic.co/downloads/elasticsearch-plugins
///////
Javadoc roots used to generate links from Painless's API reference
///////
:java8-javadoc: https://docs.oracle.com/javase/8/docs/api
:java9-javadoc: http://download.java.net/java/jigsaw/docs/api
:joda-time-javadoc: http://www.joda.org/joda-time/apidocs
:lucene-core-javadoc: http://lucene.apache.org/core/{lucene_version_path}/core
ifeval::["{release-state}"=="unreleased"]
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT
:painless-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}-SNAPSHOT
endif::[]
ifeval::["{release-state}"!="unreleased"]
:elasticsearch-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}
:painless-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}
endif::[]

View File

@ -1,7 +1,7 @@
[[java-api]]
= Java API
:ref: http://www.elastic.co/guide/en/elasticsearch/reference/master
:version: 6.0.0-alpha1
include::../Versions.asciidoc[]
[preface]
== Preface

View File

@ -1,7 +1,7 @@
[[java-rest]]
= Java REST Client
:version: 6.0.0-alpha1
include::../Versions.asciidoc[]
include::overview.asciidoc[]

View File

@ -1,10 +1,6 @@
= Elasticsearch Plugins and Integrations
:ref: https://www.elastic.co/guide/en/elasticsearch/reference/master
:guide: https://www.elastic.co/guide
:version: 6.0.0-alpha1
:lucene_version: 6.3.0
:plugin_url: https://artifacts.elastic.co/downloads/elasticsearch-plugins
include::../Versions.asciidoc[]
[[intro]]
== Introduction to plugins

View File

@ -1,44 +1,7 @@
[[elasticsearch-reference]]
= Elasticsearch Reference
:version: 6.0.0-alpha1
:major-version: 6.x
:docker-image: docker.elastic.co/elasticsearch/elasticsearch:{version}
:x-pack-baseurl: https://www.elastic.co/guide/en/x-pack/5.0
//////////
release-state can be: released | prerelease | unreleased
//////////
:release-state: unreleased
:lucene_version: 6.3.0
:branch: master
:jdk: 1.8.0_73
:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/master
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/master
:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/master/
:issue: https://github.com/elastic/elasticsearch/issues/
:pull: https://github.com/elastic/elasticsearch/pull/
///////
Javadoc roots used to generate links from Painless's API reference
///////
:java8-javadoc: https://docs.oracle.com/javase/8/docs/api
:java9-javadoc: http://download.java.net/java/jigsaw/docs/api
:joda-time-javadoc: http://www.joda.org/joda-time/apidocs
:lucene-core-javadoc: http://lucene.apache.org/core/6_4_0/core
ifeval::["{release-state}"=="unreleased"]
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT
:painless-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}-SNAPSHOT
endif::[]
ifeval::["{release-state}"!="unreleased"]
:elasticsearch-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}
:painless-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}
endif::[]
include::../Versions.asciidoc[]
include::getting-started.asciidoc[]

View File

@ -2,14 +2,14 @@
=== Install Elasticsearch with Docker
Elasticsearch is also available as a Docker image.
The image is built with {x-pack-baseurl}/index.html[X-Pack].
The image is built with {xpack}/index.html[X-Pack].
==== Security note
NOTE: {x-pack-baseurl}/index.html[X-Pack] is preinstalled in this image.
Please take a few minutes to familiarize yourself with {x-pack-baseurl}/security-getting-started.html[X-Pack Security] and how to change default passwords. The default password for the `elastic` user is `changeme`.
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: 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 {x-pack-baseurl}/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}/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.