Add placeholder to the docs to distinguish released from unreleased from prerelease versions (#20644)

Closes https://github.com/elastic/stack/issues/18
This commit is contained in:
Clinton Gormley 2016-10-06 17:56:55 +02:00
parent 63bcb4f534
commit 40bf2c206c
5 changed files with 90 additions and 0 deletions

View File

@ -3,6 +3,8 @@
:version: 6.0.0-alpha1 :version: 6.0.0-alpha1
:major-version: 6.x :major-version: 6.x
// release-state can be: released | prerelease | unreleased
:release-state: unreleased
:lucene_version: 6.2.0 :lucene_version: 6.2.0
:branch: master :branch: master
:jdk: 1.8.0_73 :jdk: 1.8.0_73

View File

@ -22,6 +22,14 @@ wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add
[[deb-repo]] [[deb-repo]]
==== Installing from the APT repository ==== Installing from the APT repository
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
You may need to install the `apt-transport-https` package on Debian before proceeding: You may need to install the `apt-transport-https` package on Debian before proceeding:
[source,sh] [source,sh]
@ -31,11 +39,25 @@ sudo apt-get install apt-transport-https
Save the repository definition to +/etc/apt/sources.list.d/elastic-{major-version}.list+: Save the repository definition to +/etc/apt/sources.list.d/elastic-{major-version}.list+:
ifeval::["{release-state}"=="released"]
["source","sh",subs="attributes,callouts"] ["source","sh",subs="attributes,callouts"]
-------------------------------------------------- --------------------------------------------------
echo "deb https://artifacts.elastic.co/packages/{major-version}-prerelease/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-{major-version}.list echo "deb https://artifacts.elastic.co/packages/{major-version}-prerelease/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-{major-version}.list
-------------------------------------------------- --------------------------------------------------
endif::[]
ifeval::["{release-state}"=="prerelease"]
["source","sh",subs="attributes,callouts"]
--------------------------------------------------
echo "deb https://artifacts.elastic.co/packages/{major-version}/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-{major-version}.list
--------------------------------------------------
endif::[]
[WARNING] [WARNING]
================================================== ==================================================
@ -83,6 +105,9 @@ sudo dpkg -i elasticsearch-{version}.deb
<1> Compare the SHA produced by `sha1sum` or `shasum` with the <1> Compare the SHA produced by `sha1sum` or `shasum` with the
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.deb.sha1[published SHA]. https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.deb.sha1[published SHA].
endif::[]
// release-state!=unreleased
include::init-systemd.asciidoc[] include::init-systemd.asciidoc[]
[[deb-running-init]] [[deb-running-init]]

View File

@ -26,10 +26,20 @@ rpm --import https://artifacts.elastic.co/GPG-KEY-elasticsearch
[[rpm-repo]] [[rpm-repo]]
==== Installing from the RPM repository ==== Installing from the RPM repository
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
Create a file called `elasticsearch.repo` in the `/etc/yum.repos.d/` directory Create a file called `elasticsearch.repo` in the `/etc/yum.repos.d/` directory
for RedHat based distributions, or in the `/etc/zypp/repos.d/` directory for for RedHat based distributions, or in the `/etc/zypp/repos.d/` directory for
OpenSuSE based distributions, containing: OpenSuSE based distributions, containing:
ifeval::["{release-state}"=="released"]
["source","sh",subs="attributes,callouts"] ["source","sh",subs="attributes,callouts"]
-------------------------------------------------- --------------------------------------------------
[elasticsearch-{major-version}] [elasticsearch-{major-version}]
@ -42,6 +52,24 @@ autorefresh=1
type=rpm-md type=rpm-md
-------------------------------------------------- --------------------------------------------------
endif::[]
ifeval::["{release-state}"=="prerelease"]
["source","sh",subs="attributes,callouts"]
--------------------------------------------------
[elasticsearch-{major-version}]
name=Elasticsearch repository for {major-version} packages
baseurl=https://artifacts.elastic.co/packages/{major-version}/yum
gpgcheck=1
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
enabled=1
autorefresh=1
type=rpm-md
--------------------------------------------------
endif::[]
And your repository is ready for use. You can now install Elasticsearch with one of the following commands: And your repository is ready for use. You can now install Elasticsearch with one of the following commands:
[source,sh] [source,sh]
@ -68,6 +96,9 @@ sudo rpm --install elasticsearch-{version}.rpm
<1> Compare the SHA produced by `sha1sum` or `shasum` with the <1> Compare the SHA produced by `sha1sum` or `shasum` with the
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.rpm.sha1[published SHA]. https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.rpm.sha1[published SHA].
endif::[]
// release-state!=unreleased
include::init-systemd.asciidoc[] include::init-systemd.asciidoc[]
[[rpm-running-init]] [[rpm-running-init]]

View File

@ -13,6 +13,14 @@ link:/downloads/past-releases[Past Releases page].
[[install-windows]] [[install-windows]]
==== Download and install the `.zip` package ==== Download and install the `.zip` package
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
Download the `.zip` archive for Elasticsearch v{version} from: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip Download the `.zip` archive for Elasticsearch v{version} from: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip
Unzip it with your favourite unzip tool. This will create a folder called Unzip it with your favourite unzip tool. This will create a folder called
@ -24,6 +32,8 @@ window, `CD` to the `%ES_HOME%` directory, for instance:
CD c:\elasticsearch-{version} CD c:\elasticsearch-{version}
---------------------------- ----------------------------
endif:[]
[[windows-running]] [[windows-running]]
==== Running Elasticsearch from the command line ==== Running Elasticsearch from the command line

View File

@ -13,8 +13,17 @@ link:/downloads/past-releases[Past Releases page].
[[install-zip]] [[install-zip]]
==== Download and install the `.zip` package ==== Download and install the `.zip` package
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
The `.zip` archive for Elastisearch v{version} can be downloaded and installed as follows: The `.zip` archive for Elastisearch v{version} can be downloaded and installed as follows:
["source","sh",subs="attributes"] ["source","sh",subs="attributes"]
-------------------------------------------- --------------------------------------------
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip
@ -26,9 +35,20 @@ cd elasticsearch-{version}/ <2>
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip.sha1[published SHA]. https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.zip.sha1[published SHA].
<2> This directory is known as `$ES_HOME`. <2> This directory is known as `$ES_HOME`.
endif::[]
[[install-targz]] [[install-targz]]
==== Download and install the `.tar.gz` package ==== Download and install the `.tar.gz` package
ifeval::["{release-state}"=="unreleased"]
Version {version} of Elasticsearch has not yet been released.
endif::[]
ifeval::["{release-state}"!="unreleased"]
The `.tar.gz` archive for Elastisearch v{version} can be downloaded and installed as follows: The `.tar.gz` archive for Elastisearch v{version} can be downloaded and installed as follows:
["source","sh",subs="attributes"] ["source","sh",subs="attributes"]
@ -42,6 +62,8 @@ cd elasticsearch-{version}/ <2>
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.tar.gz.sha1[published SHA]. https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}.tar.gz.sha1[published SHA].
<2> This directory is known as `$ES_HOME`. <2> This directory is known as `$ES_HOME`.
endif::[]
[[zip-targz-running]] [[zip-targz-running]]
==== Running Elasticsearch from the command line ==== Running Elasticsearch from the command line