silverstripe / faq
Provides Q&A pages and Solr-based search
Installs: 1 373
Dependents: 2
Suggesters: 0
Security: 0
Stars: 4
Watchers: 9
Forks: 13
Open Issues: 5
Type:silverstripe-module
Requires
Requires (Dev)
- hafriedlander/phockito: dev-master
- phpunit/phpunit: 3.7.*@stable
Suggests
- silverstripe/fulltextsearch-localsolr: For local testing of Solr
This package is auto-updated.
Last update: 2024-10-15 23:02:42 UTC
README
Introduction
This module provides FAQ functionality on top of Solr.
Just by adding the module to the project, you'll get a ModelAdmin for FAQs, where you can manage Questions & Answers. You only need to add an FAQPage type (comes with the module), and some questions and answers.
The module comes with its own Solr search index, customized to have a fuzzy search, and has its own file for stopwords and synonyms.
Requirements
- Fulltextsearch module, v2.1.0 or up.
- Phockito and PHPunit for testing, not required if you don't care about running tests.
Installation
composer require silverstripe/faq
Run a database rebuild by visiting http://yoursite.com/dev/build. This will add the required database columns and tables for the module to function.
Ensure you have silverstripe/fulltextsearch-localsolr
running (See this modules docs for starting local instance of Solr).
Run the Solr related tasks:
$ ./framework/sake dev/tasks/Solr_Configure
$ ./framework/sake dev/tasks/Solr_ReIndex
If you are using CWP
Check how to configure this module to behave like CWP-Solr on the docs.
Quickstart
-
Add a FAQPage to your CMS
-
Add an FAQ on the FAQ ModelAdmin sidebar link
-
Wait for Solr to reindex
-
Search your FAQ page :)
Features
Links
TODO
- Get static config variables from yml files for controller
- Pagetypes, search index and dataobjects easily extendable
- version FAQs (?)