Skip to content

Commit ec00b65

Browse files
chrispennychrispenny
committed
Update README and simple usage doc
1 parent 9d994ba commit ec00b65

File tree

2 files changed

+25
-18
lines changed

2 files changed

+25
-18
lines changed

‎README.md‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# 🧭 Silverstripe Discoverer > Search query module
1+
# 🧭 Silverstripe Discoverer: Search and querying module for Silverstripe CMS
22

33
* [Purpose](#purpose)
44
* [Delivery](#delivery)
5+
* [Installation](#installation)
56
* [Feature support](#feature-support)
67
* [Getting started](#getting-started)
78
* [Simple usage](docs/simple-usage.md)
89
* [Detailed result handling](docs/detailed-result-handling.md)
910
* [Detailed querying](docs/detailed-querying.md)
11+
* [Available service integration modules](#available-service-integration-modules)
1012

1113
## Purpose
1214

@@ -32,19 +34,22 @@ composer require "silverstripe/silverstripe-discoverer"
3234
*Note* this module is not functional without an
3335
[integration module](#available-service-integration-modules)
3436

37+
If you are planning to search through a page and controller, then you might also want to consider using
38+
[Silverstripe Discoverer > Search UI](https://github.com/silverstripeltd/silverstripe-discoverer-search-ui)
39+
3540
## Feature support
3641

3742
Whether or not certain features are supported **by this module**. Noting that different search providers often do things
3843
in different ways, and often have different levels of support for features. This module attempts to provide a level
3944
of functionality that is commonly supported by many different services.
4045

41-
| Feature | Module support | Future module support | Rationale |
42-
|-------------------------------------------------------------|----------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
43-
| Filters | Yes | Yes | You should (hopefully) be able to achieve any sort of nested filtering that you require. |
44-
| Facets | Partial | If desired | Facet support differs hugely between search services. Current thinking is to try and limit what sort of Facet integrations we use (EG: no Geolocation) in the hopes that if we switch services in the future, we won't lose functionality |
45-
| Multi-search | No | If desired | Not supported by many search services. It wouldn't be unreasonable effort to add this functionality though. |
46-
| Search suggestions (aka auto-complete, "did you mean", etc) | Yes | Yes | Features like auto-complete generate a lot of requests, and for a lower tiered shared service, that is something we want to cut down on. |
47-
| Click through logging | Yes | Yes | Supported in Elastic App Search, but not supported by many other Search Services (including Elasticsearch). This feature in particular is an example of the "silent treatment" we apply when a feature disappears between service providers |
46+
| Feature | Module support | Future module support | Rationale |
47+
|-------------------------------------------------------------|----------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48+
| Filters | Yes | Yes | You should (hopefully) be able to achieve any sort of nested filtering that you require. |
49+
| Facets | Partial | Partial | Facet support differs hugely between search services. Current thinking is to try and limit what sort of Facet integrations we support (EG: no Geolocation) in the hopes that if you switch services in the future, you won't lose functionality. |
50+
| Multi-search | No | If desired | Not supported by many search services. It wouldn't be unreasonable effort to add this functionality though. Plugin modules for services without mult-search could manually perform 2 searches and combine the results. |
51+
| Search suggestions (aka auto-complete, "did you mean", etc) | No | Yes | This feature comes in many different shapes and sizes between services, we do plan to add support for this feature in the very near future. |
52+
| Click through logging | Yes | Yes | Supported in Elastic App Search, but not supported by many other Search Services (including Elasticsearch). This feature in particular is an example of the "silent treatment" that might be applied when a feature disappears between service providers. |
4853

4954
## Getting started
5055

‎docs/simple-usage.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# Simple usage
22

3+
This module does not provide a search results page out of the box. Why? Because we do not want to prescribe the way that
4+
you have to interact with search.
5+
6+
That said, below we have some examples on how you could set up search using a basic Page (managed through the CMS like
7+
any other Page), and Controller.
8+
9+
**Note:** If you read through these examples, and you think they fit your use case, then you might want to consider
10+
using [Silverstripe Discoverer > Search UI](https://github.com/silverstripeltd/silverstripe-discoverer-search-ui),
11+
as this module provides most of what is described below out of the box.
12+
313
* [`SearchResults.php`](#searchresultsphp)
414
* [`SearchResultsController.php`](#searchresultscontrollerphp)
515
* [`SearchResults.ss`](#searchresultsss)
6-
7-
**Note:** This is not meant to be a feature-packed demo or a prescription for how you should implement search. This is
8-
just here to give a basic idea of how you might interact with the service components that this module provides.
16+
* [`Record.ss`](#recordss)
917

1018
Please also read the following:
1119

1220
* [Detailed usage](detailed-querying.md)
1321
* [Detailed result handling](detailed-result-handling.md)
1422

15-
This module does not provide a search results page out of the box. Why? Because we do not want to prescribe the way that
16-
you have to interact with search.
17-
18-
That said, below we have some examples on how you could set up search using a basic Page (managed through the CMS like
19-
any other Page), and Controller.
20-
2123
## `SearchResults.php`
2224

2325
A basic Page type that can be managed through the CMS.
@@ -169,7 +171,7 @@ $SearchResults
169171
170172
```
171173

172-
## `Records.ss`
174+
## `Record.ss`
173175

174176
Ok, the "hard" bit.
175177

0 commit comments

Comments
 (0)