Skip to content

Commit 5ab62cf

Browse files
ezimuelezimuel
committed
Updated docs
1 parent e0e81d6 commit 5ab62cf

9 files changed

+10
-108
lines changed

‎docs/configuration.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ include::config-hash.asciidoc[]
5555

5656
include::per-request-configuration.asciidoc[]
5757

58-
include::futures.asciidoc[]
58+
include::futures.asciidoc[]

‎docs/connecting.asciidoc

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[[connecting]]
1+
[[connceting]]
22
== Connecting
33

44
This page contains the information you need to connect and use the Client with
@@ -201,21 +201,6 @@ $client = ClientBuilder::create()
201201
----
202202

203203

204-
[discrete]
205-
[[client-comp]]
206-
=== Enabling the Compatibility Mode
207-
208-
The Elasticsearch server version 8.0 is introducing a new compatibility mode that
209-
allows you a smoother upgrade experience from 7 to 8. In a nutshell, you can use
210-
the latest 7.x Elasticsearch client with an 8.x Elasticsearch server, giving more
211-
room to coordinate the upgrade of your codebase to the next major version.
212-
213-
If you want to leverage this functionality, please make sure that you are using the
214-
latest 7.x client and set the environment variable `ELASTIC_CLIENT_APIVERSIONING`
215-
to `true`. The client is handling the rest internally. For every 8.0 and beyond
216-
client, you're all set! The compatibility mode is enabled by default.
217-
218-
219204
[discrete]
220205
[[client-usage]]
221206
=== Usage

‎docs/connection-pool.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,8 @@ The `SimpleConnectionPool` returns the next node as specified by the selector;
7878
it does not track node conditions. It returns nodes either they are dead or
7979
alive. It is a simple pool of static hosts.
8080

81-
The `SimpleConnectionPool` is recommended where the Elasticsearch deployment
82-
is located behnd a (reverse-) proxy or load balancer, where the individual
83-
Elasticsearch nodes are not visible to the client. This should be used when
84-
running Elasticsearch deployments on Cloud.
81+
The `SimpleConnectionPool` is not recommended for routine use but it may be a
82+
useful debugging tool.
8583

8684
To use the `SimpleConnectionPool`:
8785

‎docs/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
= Elasticsearch PHP Client
2+
= Elasticsearch-PHP
33

44
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
55

‎docs/installation.asciidoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,6 @@ use `dev-master` in your production code.
4343
| <= 0.90.* | `0.4`
4444
|============================
4545

46-
[discrete]
47-
[[compatibility]]
48-
=== Compatibility
49-
50-
Language clients are forward compatible; meaning that clients support communicating
51-
with greater or equal minor versions of Elasticsearch. Elasticsearch language
52-
clients are only backwards compatible with default distributions and without
53-
guarantees made.
5446

5547
[discrete]
5648
=== Composer Installation

‎docs/overview.asciidoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,11 @@ added to the client (cluster state sniffing, round-robin requests, and so on)
1414
but largely it is very barebones. This was intentional; we want a common base
1515
that more sophisticated libraries can build on top of.
1616

17-
18-
[discrete]
19-
[[psr-7-standard]]
20-
=== PSR 7 standard
21-
22-
The {es} PHP client uses the https://www.php-fig.org/psr/[PSR] 7 standard. This
23-
standard is a community effort that contains a set of interfaces defined by the
24-
PHP Framework Interop Group. For more information, refer to the
25-
https://www.php-fig.org/psr/psr-7/[PSR 7 standard documentation].
26-
27-
2817
* <<community_dsls>>
2918
* <<community-integrations>>
3019
* <<breaking_changes>>
3120

3221

3322
include::community.asciidoc[]
3423

35-
include::breaking-changes.asciidoc[]
24+
include::breaking-changes.asciidoc[]

‎docs/per-request-configuration.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $response = $client->get($params);
3939

4040
The library attempts to throw exceptions for common problems. These exceptions
4141
match the HTTP response code provided by {es}. For example, attempting to GET a
42-
nonexistent document will throw a `MissingDocument404Exception`.
42+
nonexistent document will throw a `Missing404Exception`.
4343

4444
Exceptions are a useful and consistent way to deal with problems like missing
4545
documents, syntax errors, version conflicts, and so on. But sometimes you want
@@ -48,7 +48,7 @@ test suites).
4848

4949
If you need that behavior, you can configure an `ignore` parameter. You can
5050
configure it in the `client` parameter of the request array. For instance, the
51-
example below ignores the `MissingDocument404Exception` exception and returns
51+
example below ignores the `Missing404Exception` exception and returns
5252
the JSON provided by {es} instead.
5353

5454

@@ -253,7 +253,7 @@ Array
253253

254254
It is possible to configure per-request curl timeouts via the `timeout` and
255255
`connect_timeout` parameters. These control the client-side, curl timeouts. The
256-
`connect_timeout` paramter controls how long curl should wait for the "connect"
256+
`connect_timeout` parameter controls how long curl should wait for the "connect"
257257
phase to finish, while the `timeout` parameter controls how long curl should
258258
wait for the entire request to finish.
259259

‎docs/release-notes.asciidoc

Lines changed: 0 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
[[release-notes]]
22
== Release notes
33

4-
* <<rn-7-16-0>>
5-
* <<rn-7-15-0>>
6-
* <<rn-7-14-0>>
7-
* <<rn-7-13-1>>
8-
* <<rn-7-13-0>>
94
* <<rn-7-12-0>>
105
* <<rn-7-11-0>>
116
* <<rn-7-10-0>>
@@ -29,63 +24,6 @@
2924
* <<rn-7-0-1>>
3025
* <<rn-7-0-0>>
3126

32-
[discrete]
33-
[[rn-7-16-0]]
34-
=== 7.16.0
35-
36-
* Added support of includePortInHostHeader in ClientBuilder::fromConfig
37-
https://github.com/elastic/elasticsearch-php/pull/1181[#1181]
38-
* Fixed UTF-16 issue in SmartSerializer with single unpaired surrogate in unicode escape
39-
https://github.com/elastic/elasticsearch-php/pull/1179[#1179]
40-
* Replace trait with abstract class to avoid Deprecated Functionality issue in PHP 8.1
41-
https://github.com/elastic/elasticsearch-php/pull/1175[#1175]
42-
43-
44-
[discrete]
45-
[[rn-7-15-0]]
46-
=== 7.15.0
47-
48-
* Updated endpoints for Elasticsearch 7.15.0
49-
https://github.com/elastic/elasticsearch-php/commit/995f6d4bde7de76004e95d7a434b1d59da7a7e75[995f6d4]
50-
51-
52-
[discrete]
53-
[[rn-7-14-0]]
54-
=== 7.14.0
55-
56-
* Usage of psr/log version 2
57-
https://github.com/elastic/elasticsearch-php/pull/1154[#1154]
58-
* Update search iterators to send `scroll_id` inside the request body
59-
https://github.com/elastic/elasticsearch-php/pull/1134[#1134]
60-
* Added the `ingest.geoip.downloader.enabled=false` setting for ES
61-
https://github.com/elastic/elasticsearch-php/commit/586735109dc18f22bfdf3b73ab0621b37e857be1[5867351]
62-
* Removed phpcs for autogenerated files (endpoints)
63-
https://github.com/elastic/elasticsearch-php/commit/651c57b2e6bf98a0fd48220949966e630e5a804a[651c57b]
64-
65-
66-
[discrete]
67-
[[rn-7-13-1]]
68-
=== 7.13.1
69-
70-
* Added port in url for trace and logger messages
71-
https://github.com/elastic/elasticsearch-php/pull/1126[#1126]
72-
73-
74-
[discrete]
75-
[[rn-7-13-0]]
76-
=== 7.13.0
77-
78-
* (DOCS) Added the HTTP meta data section
79-
https://github.com/elastic/elasticsearch-php/pull/1143[#1143]
80-
* Added support for API Compatibility Header
81-
https://github.com/elastic/elasticsearch-php/pull/1142[#1142]
82-
* (DOCS) Added Helpers section to PHP book
83-
https://github.com/elastic/elasticsearch-php/pull/1129[#1129]
84-
* Added the API description in phpdoc section for each endpoint
85-
https://github.com/elastic/elasticsearch-php/commit/9e05c8108b638b60cc676b6a4f4be97c7df9eb64[9e05c81]
86-
* Usage of PHPUnit 9 only + migrated xml configurations
87-
https://github.com/elastic/elasticsearch-php/commit/038b5dd043dc76b20b9f5f265ea914a38d33568d[038b5dd]
88-
8927

9028
[discrete]
9129
[[rn-7-12-0]]

‎docs/selectors.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ $client = ClientBuilder::create()
8484

8585
Note that the implementation is specified via a namespace path to the class.
8686

87-
87+
[discrete]
8888
=== Custom Selector
8989

9090
You can implement your own custom selector. Custom selectors must implement

0 commit comments

Comments
 (0)