mirror of
https://github.com/Codappix/search_core.git
synced 2024-11-22 16:16:12 +01:00
FEATURE: Document usage of frontend plugin and contribution
This commit is contained in:
parent
ff49198a0b
commit
e6ce2dac25
3 changed files with 38 additions and 0 deletions
29
Documentation/source/development.rst
Normal file
29
Documentation/source/development.rst
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
.. _contribution:
|
||||||
|
|
||||||
|
Contribution
|
||||||
|
============
|
||||||
|
|
||||||
|
Everyone is welcome to contribute, whether it's code, issues, feature requests or any other kind.
|
||||||
|
|
||||||
|
Below is a documentation what to respect during contributions.
|
||||||
|
|
||||||
|
.. _contribution_development:
|
||||||
|
|
||||||
|
Development
|
||||||
|
-----------
|
||||||
|
|
||||||
|
All changes are introduced through pull requests at `Github`_ and should contain the following:
|
||||||
|
|
||||||
|
* Adjusted tests if tests existed before. Otherwise they will break on `travis-ci`_.
|
||||||
|
|
||||||
|
* New tests whenever possible and usefull.
|
||||||
|
|
||||||
|
* Code has to follow `PSR-2`_.
|
||||||
|
|
||||||
|
* Adjusted documentation.
|
||||||
|
|
||||||
|
* Make sure to follow the documented :ref:`concepts`.
|
||||||
|
|
||||||
|
.. _Github: https://github.com/DanielSiepmann/search_core
|
||||||
|
.. _travis-ci: https://travis-ci.org/
|
||||||
|
.. _PSR-2: http://www.php-fig.org/psr/psr-2/
|
|
@ -13,3 +13,4 @@ Table of Contents
|
||||||
concepts
|
concepts
|
||||||
connections
|
connections
|
||||||
indexer
|
indexer
|
||||||
|
development
|
||||||
|
|
|
@ -29,3 +29,11 @@ The tables have to be white listed through :ref:`allowedTables` option.
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Not all hook operations are supported yet, see :issue:`27`.
|
Not all hook operations are supported yet, see :issue:`27`.
|
||||||
|
|
||||||
|
.. _usage_searching:
|
||||||
|
|
||||||
|
Searching / Frontend Plugin
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
To provide a search interface you can insert the frontend Plugin as normal content element of type
|
||||||
|
plugin. The plugin is named *Search Core*.
|
||||||
|
|
Loading…
Reference in a new issue