From 40bc28de95ebf234150b2dc6098f84f4f92bab69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 16 Sep 2021 10:53:29 +0200 Subject: [PATCH] [DOCS] Adds intro text to the index file, changes snippet attributes. --- docs/connecting.asciidoc | 8 ++++++-- docs/index.asciidoc | 12 ++++++++++++ docs/installation.asciidoc | 12 ++++++++---- 3 files changed, 26 insertions(+), 6 deletions(-) diff --git a/docs/connecting.asciidoc b/docs/connecting.asciidoc index 7272b36e82613..9b13247f992b0 100644 --- a/docs/connecting.asciidoc +++ b/docs/connecting.asciidoc @@ -1,10 +1,14 @@ [[connecting]] == Connecting +experimental[] + The code snippet below shows how to initialize a low level REST client and the Jackson object mapper to configure an ElasticsearchClient: -``` + +["source","java"] +-------------------------------------------------- // Create the low-level client RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200)).build(); @@ -13,7 +17,7 @@ Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper // And create our API client ElasticsearchClient client = new ElasticsearchClient(transport); -``` +-------------------------------------------------- Authentication is managed by the https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html[low-level Rest Client]. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 15a6a55b084f8..d3836a59455bc 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,5 +1,17 @@ = Elasticsearch Java High-level client +[partintro] +-- + +The {es} Java High-level REST Client is an experimental Java client for {es}. +It removes all dependencies to the {es} server code base. + +* <> +* <> +* <> + +-- + :branch: master include::{asciidoc-dir}/../../shared/attributes.asciidoc[] diff --git a/docs/installation.asciidoc b/docs/installation.asciidoc index 6ab6a8076d29c..dba119ee02508 100644 --- a/docs/installation.asciidoc +++ b/docs/installation.asciidoc @@ -1,6 +1,8 @@ [[installation]] == Installation +experimental[] + This page guides you through the installation process of the client. Requirements: @@ -25,7 +27,8 @@ https://snapshots.elastic.co/maven/[Elastic's Maven snapshot repository]. [[gradle]] === Installation in a Gradle project by using Jackson -``` +["source","groovy",subs="attributes"] +-------------------------------------------------- repositories { mavenCentral() maven { @@ -38,7 +41,7 @@ dependencies { implementation 'co.elastic.clients:elasticsearch-java:7.15.0-SNAPSHOT' implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.3' } -``` +-------------------------------------------------- [discrete] [[maven]] @@ -47,7 +50,8 @@ dependencies { In the `pom.xml` of your project, add the following repository definition and dependencies: -``` +["source","xml",subs="attributes"] +-------------------------------------------------- @@ -74,7 +78,7 @@ dependencies: -``` +-------------------------------------------------- [discrete] [[compatibility]]