Skip to content

Commit 524ebda

Browse files
committed
Docs: make the welcome page more obvious
Closes #31. (cherry picked from commit ab3cde3)
1 parent e35e515 commit 524ebda

File tree

5 files changed

+155
-801
lines changed

5 files changed

+155
-801
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
/.classpath
1111
*.vmoptions
1212
.local-execution-hints.log
13+
plugin_tools

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,30 @@ Google Compute Engine Cloud Plugin for Elasticsearch
33

44
The GCE Cloud plugin allows to use GCE API for the unicast discovery mechanism.
55

6-
In order to install the plugin, simply run: `bin/plugin -install elasticsearch/elasticsearch-cloud-gce/2.1.1`.
6+
In order to install the plugin, run:
77

8-
* For master elasticsearch versions, look at [master branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/master).
9-
* For 1.3.x elasticsearch versions, look at [es-1.3 branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-1.3).
10-
* For 1.2.x elasticsearch versions, look at [es-1.2 branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-1.2).
11-
* For 1.1.x elasticsearch versions, look at [es-1.1 branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-1.1).
12-
* For 1.0.x elasticsearch versions, look at [es-1.0 branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-1.0).
13-
* For 0.90.x elasticsearch versions, look at [es-0.90 branch](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-0.90).
8+
```sh
9+
bin/plugin -install elasticsearch/elasticsearch-cloud-gce/2.2.0
10+
```
1411

15-
| GCE Cloud Plugin | elasticsearch | gce api | Release date |
16-
|----------------------------|---------------------|--------------|:------------:|
17-
| 3.0.0-SNAPSHOT | master | 1.18.0-rc | XXXX-XX-XX |
12+
You need to install a version matching your Elasticsearch version:
1813

19-
Please read documentation relative to the version you are using:
14+
| Elasticsearch | Azure Cloud Plugin| Docs |
15+
|------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------|
16+
| master | Build from source | See below |
17+
| es-1.3 | Build from source | [2.3.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/es-1.3/#google-compute-engine-cloud-plugin-for-elasticsearch)|
18+
| es-1.2 | 2.2.0 | [2.2.0](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/v2.2.0/#google-compute-engine-cloud-plugin-for-elasticsearch)|
19+
| es-1.1 | 2.1.2 | [2.1.2](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/v2.1.2/#google-compute-engine-cloud-plugin-for-elasticsearch)|
20+
| es-1.0 | 2.0.1 | [2.0.1](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/v2.0.1/#google-compute-engine-cloud-plugin-for-elasticsearch)|
21+
| es-0.90 | 1.3.0 | [1.3.0](https://github.com/elasticsearch/elasticsearch-cloud-gce/tree/v1.3.0/#google-compute-engine-cloud-plugin-for-elasticsearch)|
2022

21-
* [3.0.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-cloud-gce/blob/master/README.md)
23+
To build a `SNAPSHOT` version, you need to build it with Maven:
24+
25+
```bash
26+
mvn clean install
27+
plugin --install cloud-azure \
28+
--url file:target/releases/elasticsearch-cloud-gce-X.X.X-SNAPSHOT.zip
29+
```
2230

2331

2432
Google Compute Engine Virtual Machine Discovery

0 commit comments

Comments
 (0)