Merge pull request #35 from DanielSiepmann/feature/add-documentation

Feature/add documentation
This commit is contained in:
Daniel Siepmann 2016-12-20 09:27:52 +01:00 committed by GitHub
commit 8441dcdff2
6 changed files with 40 additions and 3 deletions

View file

@ -303,7 +303,7 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
't3TcaRef': ('https://docs.typo3.org/typo3cms/TCAReference/', None),
't3tcaref': ('https://docs.typo3.org/typo3cms/TCAReference/', None),
}
extlinks = {
'project': ('https://github.com/DanielSiepmann/search_core/projects/%s', 'Github project: '),

View 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/

View file

@ -13,3 +13,4 @@ Table of Contents
concepts
connections
indexer
development

View file

@ -12,7 +12,7 @@ The extension provides the following indexer out of the box:
TcaIndexer
----------
Provides zero configuration TYPO3 integration by using the :ref:`t3TcaRef:start`. You just can
Provides zero configuration TYPO3 integration by using the :ref:`t3tcaref:start`. You just can
start indexing TYPO3.
The indexer will use the TCA to fetch all necessary information like relations. Currently the

View file

@ -12,7 +12,6 @@ or by `downloading`_ and placing it inside the :file:`typo3conf/ext`-Folder of y
In that case you need to install all dependencies yourself. Dependencies are:
.. literalinclude:: ../../composer.json
:language: json
:caption: Dependencies from composer.json
:lines: 19-21
:dedent: 8

View file

@ -29,3 +29,11 @@ The tables have to be white listed through :ref:`allowedTables` option.
.. note::
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*.