Skip to content

Commit 99c32dc

Browse files
committed
[DOCS] Updates README and warns user about client discontinuation in 9.x
1 parent ef2c709 commit 99c32dc

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@
55
![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)
66
[![Build status](https://badge.buildkite.com/a6c44f2af741c866381fb3c845e8d4b0e9b5c5883ef84ac30e.svg)](https://buildkite.com/elastic/enterprise-search-ruby)
77

8+
> [!WARNING] **Enterprise Search will be discontinued in 9.0.**
9+
10+
> Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
11+
> We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
12+
13+
> Here are some useful links with more information:
14+
> * Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
15+
> * Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
16+
17+
818
Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
919

1020
## Installation

elastic-enterprise-search.gemspec

+12
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,17 @@ Gem::Specification.new do |s|
6262
s.add_development_dependency 'faraday-net_http_persistent'
6363
s.add_development_dependency 'faraday-patron' unless defined? JRUBY_VERSION
6464
s.add_development_dependency 'faraday-typhoeus'
65+
66+
s.post_install_message = <<~MESSAGE
67+
68+
Warning: Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes.
69+
Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
70+
We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
71+
72+
Here are some useful links with more information:
73+
* Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
74+
* Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
75+
76+
MESSAGE
6577
end
6678
# rubocop:enable Metrics/BlockLength

0 commit comments

Comments
 (0)