Skip to content

Commit

Permalink
[DOCS] add links to javadocs to clients docs (#25745)
Browse files Browse the repository at this point in the history
We publish javadocs to artifacts.elastic.co (and snapshots.elastic.co) for a while. This commit adds the link to them to the transport client, low level REST client, sniffer and high level REST client pages.

Closes #23761
  • Loading branch information
javanna committed Jul 31, 2017
1 parent 1a89b2a commit d907006
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 1 deletion.
8 changes: 8 additions & 0 deletions docs/Versions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,19 @@ Javadoc roots used to generate links from Painless's API reference

ifeval::["{release-state}"=="unreleased"]
:elasticsearch-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/elasticsearch/{version}-SNAPSHOT
:transport-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/transport/{version}-SNAPSHOT
:rest-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/{version}-SNAPSHOT
:rest-client-sniffer-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client-sniffer/{version}-SNAPSHOT
:rest-high-level-client-javadoc: https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-high-level-client/{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}
:transport-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/transport/{version}
:rest-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/{version}
:rest-client-sniffer-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client-sniffer/{version}
:rest-high-level-client-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-high-level-client/{version}
:painless-javadoc: https://artifacts.elastic.co/javadoc/org/elasticsearch/painless/lang-painless/{version}
endif::[]

Expand Down
3 changes: 3 additions & 0 deletions docs/java-api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ Additionally, operations on a client may be accumulated and executed in
Note, all the APIs are exposed through the
Java API (actually, the Java API is used internally to execute them).

== Javadoc

The javadoc for the transport client can be found at {transport-client-javadoc}/index.html.

== Maven Repository

Expand Down
5 changes: 5 additions & 0 deletions docs/java-rest/high-level/usage.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
This section describes how to get started with the high-level REST client from
getting the artifact to using it in an application.

[[java-rest-high-javadoc]]
=== Javadoc

The javadoc for the REST high level client can be found at {rest-high-level-client-javadoc}/index.html.

[[java-rest-high-usage-maven]]
=== Maven Repository

Expand Down
7 changes: 6 additions & 1 deletion docs/java-rest/low-level/sniffer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,14 @@ Nodes Info api and uses jackson to parse the obtained json response.

Compatible with Elasticsearch 2.x and onwards.

[[java-rest-sniffer-javadoc]]
=== Javadoc

The javadoc for the REST client sniffer can be found at {rest-client-sniffer-javadoc}/index.html.

=== Maven Repository

The low-level REST client is subject to the same release cycle as
The REST client sniffer is subject to the same release cycle as
elasticsearch. Replace the version with the desired sniffer version, first
released with `5.0.0-alpha4`. There is no relation between the sniffer version
and the elasticsearch version that the client can communicate with. Sniffer
Expand Down
5 changes: 5 additions & 0 deletions docs/java-rest/low-level/usage.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
This section describes how to get started with the low-level REST client from
getting the artifact to using it in an application.

[[java-rest-low-javadoc]]
=== Javadoc

The javadoc for the low level REST client can be found at {rest-client-javadoc}/index.html.

[[java-rest-low-usage-maven]]
=== Maven Repository

Expand Down

0 comments on commit d907006

Please sign in to comment.