Problem/Motivation

Currently, the Elasticsearch Connector module has a documentation guide, which contains a sub-guide for developers, but we only have minimal documentation for site builders!

Proposed resolution

Add documentation for site builders.

Note that other people maintain documentation for...

We could start by linking to those ones, and filling in the gaps (especially between setting up Elasticsearch and setting up Search API).

Remaining tasks

  1. Create a sub-guide for site builders - done by @mparker17 - Using Elasticsearch Connector 8.0.x
  2. Stub a page for setting up Elasticsearch - done by @mparker17 - Setting up an Elasticsearch cluster to connect to
  3. Stub a page for setting up Search API - done by @mparker17 - Required modules § Search API
  4. Stub a page for installing Elasticsearch Connector - done by @mparker17 - Required modules § Elasticsearch Connector
  5. Stub a page for connecting Search API to Elasticsearch through Elasticsearch Connector - done by @mparker17 - Set up a Search API Server with an Elasticsearch backend and Add a Search API Index
  6. Stub a page for setting up a simple search view - done by @mparker17 - Add a search UI

User interface changes

None.

API changes

None.

Data model changes

None.

Original report by @BigEd

I have managed to get a search index connected to Elastic and importing the data.

Trouble is I have now spent ages trying to render the data out in views. I am using the search api but could really do with a guide and there is no documentation to be found.

Any where you can point me to?

Comments

skek’s picture

skek commented

Hi @BigEd,

Actually the search api integration of Elasticsearch Connector is just a simple interface, allowing you to interact with the Elasticsearch backend. You can check the search_api_views documentation for more details on how to render your data.
A quick tip is to check the commerce kickstart distribution and there you can see for example /products page. It has been setup using the search_api_views module and can refer to it as an example.
You can use http://simplytest.me to install a fresh copy of commerce kickstart 2 (7.x-2.x branch) and examine /products view.
However if you have issues with the returned fields from elasticsearch please let me know.

Best Regards,
Nikolay Ignatov

mparker17’s picture

mparker17
he/him
Primary language English
Location UTC-5
commented
Title: Documentation » Add documentation for site builders
Version: 7.x-1.0-alpha7 » 8.0.x-dev
Issue summary: View changes

I think documentation for site builders would be very useful, so I'm moving this to the 8.0.x branch and updating the issue summary a bit.

mparker17’s picture

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

Added a sub-guide for setting up an Elasticsearch cluster to connect to and updated the issue summary with links.

mparker17’s picture

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

I've built what I feel is a good starting point for a guide - Using Elasticsearch Connector 8.0.x

There's more information to fill in, but I think that can be done by myself and other contributors, or requested in follow-up issues. Note that I didn't want to duplicate documentation elsewhere, so where possible I directed readers to more-comprehensive guides.

I'm going to tentatively mark this as Fixed. I think if you notice any important omissions or serious problems with the guide, then feel free to re-open this ticket, but for everything else, a more-focused follow-up issue would be best.

Thanks for your understanding and patience!

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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