silverstripe/faq

Provides Q&A pages and Solr-based search

Maintainers

Details

github.com/silverstripe/silverstripe-faq

Homepage

Source

Issues

Installs: 1 374

Dependents: 2

Suggesters: 0

Security: 0

Stars: 4

Watchers: 9

Forks: 13

Open Issues: 5

Type:silverstripe-module

1.1.0 2016-10-29 05:16 UTC

Requires

Requires (Dev)

Suggests

BSD-3-Clause 17b173167f79bd4454685af7bcff19415b98e308

  • wgodfrey <wilfred.woop@silverstripe.com>
  • drivera <denise.woop@silverstripe.com>

solrsearchFAQsilverstripe

This package is auto-updated.

Last update: 2024-12-15 23:17:53 UTC

README

Build Status Latest Stable Version Total Downloads License Dependency Status Reference Status

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

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

Links

TODO

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