(note that only maintainers and content administrators can complete this task)

Problem/Motivation

The Elasticsearch Connector's project page is a bit outdated - in particular:

  1. it doesn't follow the project page template,
  2. it doesn't mention how it differs from the Search API OpenSearch module and when that might be a good choice to use,
  3. it's not clear which version of the module you should install depending on which version of ElasticSearch you are using (see #3315956-5: Which version of this module should I use? and #3261340-18: Call to undefined method when enabling elasticsearch_connector_views) (it also suggests using the 8.0.x branch for ElasticSearch 7, which is not correct),
  4. it mentions a hosted ElasticSearch solution that doesn't exist anymore (QBox)
  5. it has a bunch of information that only applies to the Drupal 7 version of the module (which will be end-of-life on 2025-01-05), but isn't clear about that, i.e.: CTools requirement, separate library installation,
  6. it mentions a number of sub-modules that only exist for Drupal 7 (these haven't been updated in 4+ years), and,
  7. the initial development credits can be moved to the new Supporting organizations field

Proposed resolution

Update the project page, taking into consideration the project page template, the 8.0.x README, and the information in #3315956-5: Which version of this module should I use?.

Remaining tasks

  1. Propose new content
  2. Review and feedback
  3. RTBC and feedback
  4. Update the page (a maintainer will need to do this)
  5. Alternate text for the screenshot
  6. Supporting organizations
  7. Submission guidelines? - Decided not to
  8. Custom issue summary template? - Decided not to
  9. Is the documentation link(s) up-to-date?
  10. Release code changes — released in 8.0.0-alpha1

User interface changes

None.

API changes

None.

Data model changes

None.

Issue fork elasticsearch_connector-3427497

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

mparker17 created an issue. See original summary.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented

I found that there are docs for a README template, and a Project Page template.

And, there's now a button on Project Edit pgaes to Copy README.md or README.txt file to the description

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes
Status: Active » Needs review

Here's a proposal for a new project page... feedback welcome!

Elasticsearch is a powerful, distributed, RESTful search and analytics engine based on Apache Lucene that supports full-text search, vector search, retrieval augmented generation (RAG), facets, spellchecking, hit highlighting, auto-completion, location-based searching, and more.

This modules provides a Search API backend for Elasticsearch, using the official Elasticsearch PHP Client.

Note that, in January 2021, Amazon forked Elasticsearch (then at version 7.10.2)
to create OpenSearch, and the two projects have diverged over time. If you are using OpenSearch, please consider using the Search API OpenSearch module instead.

Requirements

Elasticsearch Connector requires the Search API module to function.

The following modules are optional, but can extend the functionality of Elasticsearch Connector:

Roadmap

The ElasticSearch Connector maintainers intend to support ElasticSearch only, i.e.: we do not intend to support OpenSearch, because the Search API OpenSearch module does that already.

The maintainers intend to support versions of this module that are compatible with the currently-supported versions of Elasticsearch. For more information, please see Elasticsearch's documentation on Elastic Product End of Life Dates.

Elasticsearch release series Drupal module release series Drupal module supported?
8.x 8.0.* Yes
7.x 8.x-7.* Yes
6.x 8.x-6.* No
5.x 8.x-5.*, 7.x-5.* 7.x-5.* only
2.x, 1.x 8.x-2.*, 7.x-2.* No
1.x 7.x-1.* Yes

Known problems

If you find a problem, please let us know by adding an issue!

In the 8.0.* release series, changing the mapping of an existing field or deleting a field will cause the search index to be cleared, and all items queued for re-indexing. This is a limitation of Elasticsearch: see the Elasticsearch documentation on their Update mapping API for more details. We plan to mitigate this by using Elasticsearch's Aliases API to automatically creating a new index and reindexing to it in #3248665: Support Aliases API and zero downtime mapping updates.

Credits

NodeSpark, Google Summer of Code (GSoC) 2014, FFW, and Utilis.io sponsored initial development of Elasticsearch Connector.

Fame Helsinki, Ontario Digital Service, and Consensus Enterprises sponsored maintenance and support for Elasticsearch 8.

This module was created by Nikolay Ignatov (skek) who maintains the list of maintainers. If you would like to become a maintainer yourself, please reach out to him directly.

Note that there is at least one module that extends Elasticsearch Connector:

Dependencies

In order to function, this module requires a connection to an Elasticsearch cluster:

  • Elasticsearch B.V., the company that created Elasticsearch and sponsors its development, offers Elasticsearch as a Service through a product called Elastic Cloud (which can be hosted on Amazon Web Services (AWS), Google Cloud Platform (GCP), and/or Microsoft Azure, and has a 14-day free trial).
  • Some hosting providers (e.g.: Platform.sh, Lagoon) offer Elasticsearch plugins.
  • You can also self-host Elasticsearch with Docker or Kubernetes.
  • To test with a single-node cluster in CI, see this project's .gitlab-ci.yml on the 8.0.x branch.
  • For local development, both ddev and lando provide officially-supported plugins; or you can run it locally.
sokru’s picture

sokru commented
Status: Needs review » Reviewed & tested by the community

Looks good, I'll update the project page soon.

I'll add https://www.drupal.org/project/search_api_elasticsearch_synonym to list of modules that extend Elasticsearch Connector. Currently it relies on events provided by 8.x-7.x, so I should work on #3433222: Deprecate events and hooks in 8.x-7.x and #3433226: Add index to AlterSettingsEvent for backward compatibility so the upgrade would be easier for modules extending Elasticsearch Connector.

sokru opened merge request !53

sokru’s picture

sokru commented

The project page has button to copy the description from codebase's README.md file so I think it makes sense to also update the file.

Modified the roadmap table to also include the maintenance status of various versions. Wonder if we should make even stronger recommendation for 8.0.x version.

  • sokru committed cf4127f4 on 8.0.x 
    Issue #3427497 by sokru, mparker17: Update the project page
sokru’s picture

sokru commented
Status: Reviewed & tested by the community » Fixed

Project page is now updated.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes

Thanks @sokru!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Issue summary: View changes

Update remaining tasks.