Skip to content

Commit 9a0a089

Browse files
authored
Merge pull request #17 from szabosteve/toc
[DOCS] Adds intro text to the index file, changes snippet attributes
2 parents 80abf0e + b609460 commit 9a0a089

File tree

3 files changed

+26
-6
lines changed

3 files changed

+26
-6
lines changed

docs/connecting.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[[connecting]]
22
== Connecting
33

4+
experimental[]
5+
46
The code snippet below shows how to initialize a low level REST client and the
57
Jackson object mapper to configure an ElasticsearchClient:
68

7-
```
9+
10+
["source","java"]
11+
--------------------------------------------------
812
// Create the low-level client
913
RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200)).build();
1014
@@ -13,7 +17,7 @@ Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper
1317
1418
// And create our API client
1519
ElasticsearchClient client = new ElasticsearchClient(transport);
16-
```
20+
--------------------------------------------------
1721

1822
Authentication is managed by the
1923
https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html[low-level Rest Client].

docs/index.asciidoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
= Elasticsearch Java High-level client
22

3+
[partintro]
4+
--
5+
6+
The {es} Java High-level REST Client is an experimental Java client for {es}.
7+
It removes all dependencies to the {es} server code base.
8+
9+
* <<introduction>>
10+
* <<installation>>
11+
* <<connecting>>
12+
13+
--
14+
315
:branch: master
416
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
517

docs/installation.asciidoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[[installation]]
22
== Installation
33

4+
experimental[]
5+
46
This page guides you through the installation process of the client.
57

68
Requirements:
@@ -25,7 +27,8 @@ https://snapshots.elastic.co/maven/[Elastic's Maven snapshot repository].
2527
[[gradle]]
2628
=== Installation in a Gradle project by using Jackson
2729

28-
```
30+
["source","groovy",subs="attributes"]
31+
--------------------------------------------------
2932
repositories {
3033
mavenCentral()
3134
maven {
@@ -38,7 +41,7 @@ dependencies {
3841
implementation 'co.elastic.clients:elasticsearch-java:7.15.0-SNAPSHOT'
3942
implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.3'
4043
}
41-
```
44+
--------------------------------------------------
4245

4346
[discrete]
4447
[[maven]]
@@ -47,7 +50,8 @@ dependencies {
4750
In the `pom.xml` of your project, add the following repository definition and
4851
dependencies:
4952

50-
```
53+
["source","xml",subs="attributes"]
54+
--------------------------------------------------
5155
<project>
5256
5357
<repositories>
@@ -74,7 +78,7 @@ dependencies:
7478
</dependencies>
7579
7680
</project>
77-
```
81+
--------------------------------------------------
7882

7983
[discrete]
8084
[[compatibility]]

0 commit comments

Comments
 (0)