docs/guide/overview.asciidoc in elastic-enterprise-search-8.2.1 vs docs/guide/overview.asciidoc in elastic-enterprise-search-8.3.0

- old
+ new

@@ -8,12 +8,14 @@ Current development happens in the main branch. The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**: -For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library. +* For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y`) of the library. +* For **Elastic Enterprise Search 8.0** and later, use the major version 8 (`8.x.y`) of the library. + [discrete] === HTTP Library This library uses https://github.com/elastic/elastic-transport-ruby[elastic-transport], the low-level Ruby client for connecting to an Elastic clusters - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client]. It uses https://rubygems.org/gems/faraday[Faraday], which supports several https://lostisland.github.io/faraday/adapters/[adapters] and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], https://github.com/toland/patron[patron] or https://github.com/typhoeus/typhoeus[Typhoeus]. For JRuby, https://github.com/cheald/manticore[Manticore] is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it: @@ -25,10 +27,10 @@ client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent) --------------------------------------------------- All requests, if successful, will return an `Elastic::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`. -`elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://rubydoc.info/gems/elastic-transport[RubyDoc]. +`elastic-transport` defines a https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elastic-transport-ruby#exception-handling[here]. You can find the full documentation for `elastic-transport` at https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html[our official documentation] and https://rubydoc.info/gems/elastic-transport[RubyDoc]. The clients pass different options to transport, you can check them out https://rubydoc.info/github/elastic/enterprise-search-ruby/Elastic/EnterpriseSearch/Client[on RubyDocs]. [discrete] ==== Setting the host and port