Skip to content

[DOCS] Adds anchor IDs #848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/breaking-changes.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[breaking_changes]]
== Breaking changes from 5.x

None! :)
2 changes: 1 addition & 1 deletion docs/community.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[community_dsls]]
== Community DSLs

=== ElasticsearchDSL
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[configuration]]
== Configuration

Almost every aspect of the client is configurable. Most users will only need to configure a few parameters to suit
Expand Down
2 changes: 1 addition & 1 deletion docs/connection-pool.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[connection_pool]]
== Connection Pool

The connection pool is an object inside the client that is responsible for maintaining the current list of nodes.
Expand Down
6 changes: 4 additions & 2 deletions docs/crud.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[indexing_documents]]
== Indexing Documents

When you add documents to Elasticsearch, you index JSON documents. This maps naturally to PHP associative arrays, since
Expand Down Expand Up @@ -129,6 +129,7 @@ if (!empty($params['body'])) {
}
----

[[getting_documents]]
== Getting Documents

Elasticsearch provides realtime GETs of documents. This means that as soon as the document has been indexed and your
Expand All @@ -148,6 +149,7 @@ $response = $client->get($params);
----
{zwsp} +

[[updating_documents]]
== Updating Documents

Updating a document allows you to either completely replace the contents of the existing document, or perform a partial
Expand Down Expand Up @@ -228,7 +230,7 @@ $response = $client->update($params);
----
{zwsp} +


[[deleting_documents]]
== Deleting documents

Finally, you can delete documents by specifying their full `/index/type/id` path:
Expand Down
2 changes: 1 addition & 1 deletion docs/futures.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[future_mode]]
== Future Mode

The client offers a mode called "future" or "async" mode. This allows batch processing of requests (sent in parallel
Expand Down
2 changes: 1 addition & 1 deletion docs/index-operations.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[index_management]]
== Index Management Operations

Index management operations allow you to manage the indices in your Elasticsearch cluster, such as creating, deleting and
Expand Down
1 change: 1 addition & 0 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[installation]]
== Installation

Elasticsearch-php only has a three requirements that you need to worry about:
Expand Down
2 changes: 1 addition & 1 deletion docs/namespaces.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[namespaces]]
== Namespaces

The client has a number of "namespaces", which generally expose administrative
Expand Down
1 change: 1 addition & 0 deletions docs/overview.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[overview]]
== Overview

This is the official PHP client for Elasticsearch. It is designed to be a very low-level client that does not stray from the REST API.
Expand Down
2 changes: 1 addition & 1 deletion docs/per-request-configuration.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[per_request_configuration]]
== Per-request configuration

There are several configurations that can be set on a per-request basis, rather than at a connection- or client-level.
Expand Down
1 change: 1 addition & 0 deletions docs/php-version-requirement.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[php_version_requirement]]
== PHP Version Requirement

Version 5.0 of Elasticsearch-PHP requires PHP version 5.6.6 or higher. In addition, it requires the native JSON
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[quickstart]]
== Quickstart

This section will give you a quick overview of the client and how the major functions work.
Expand Down
1 change: 1 addition & 0 deletions docs/search-operations.asciidoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[search_operations]]
== Search Operations

Well...it isn't called elasticsearch for nothing! Let's talk about search operations in the client.
Expand Down
2 changes: 1 addition & 1 deletion docs/security.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[security]]
== Security

The Elasticsearch-PHP client supports two security features: HTTP Authentication and SSL encryption.
Expand Down
2 changes: 1 addition & 1 deletion docs/selectors.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[selectors]]
== Selectors

The connection pool maintains the list of connections, and decides when nodes should transition from alive to dead (and
Expand Down
2 changes: 1 addition & 1 deletion docs/serializers.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[serializers]]
== Serializers

The client has three serializers available. You will most likely never need
Expand Down