silverstripe/faq

Provides Q&A pages and Solr-based search

1.1.0 2016-10-29 05:16 UTC

Requires

• silverstripe/fulltextsearch: ^2.1.0
• silverstripe/taxonomy: ^1.0
• undefinedoffset/sortablegridfield: *

Requires (Dev)

• hafriedlander/phockito: dev-master
• phpunit/phpunit: 3.7.*@stable

Suggests

• silverstripe/fulltextsearch-localsolr: For local testing of Solr

BSD-3-Clause

• wgodfrey
• drivera

• solr
• search
• FAQ
• silverstripe

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

1. Add a FAQPage to your CMS

   

2. Add an FAQ on the FAQ ModelAdmin sidebar link

   

3. Wait for Solr to reindex

4. Search your FAQ page :)

   

Features

• Featured FAQs
• Categories

Links

• Module configuration
• Configuring Solr
• Using CWP

TODO

• Get static config variables from yml files for controller
• Pagetypes, search index and dataobjects easily extendable
• version FAQs (?)