From ff49198a0bd9bcda81415e07fbb2ea2f43fbdded Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Tue, 20 Dec 2016 09:26:24 +0100 Subject: [PATCH 1/2] HOTFIX: Fix some warnings during documentation rendering --- Documentation/source/conf.py | 2 +- Documentation/source/indexer.rst | 2 +- Documentation/source/installation.rst | 1 - 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/source/conf.py b/Documentation/source/conf.py index 1da80bc..07129e7 100644 --- a/Documentation/source/conf.py +++ b/Documentation/source/conf.py @@ -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: '), diff --git a/Documentation/source/indexer.rst b/Documentation/source/indexer.rst index 4555d68..01d7b18 100644 --- a/Documentation/source/indexer.rst +++ b/Documentation/source/indexer.rst @@ -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 diff --git a/Documentation/source/installation.rst b/Documentation/source/installation.rst index aa7b572..614b6e6 100644 --- a/Documentation/source/installation.rst +++ b/Documentation/source/installation.rst @@ -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 From e6ce2dac25663027ea173defa107888dccc96d61 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Tue, 20 Dec 2016 09:26:52 +0100 Subject: [PATCH 2/2] FEATURE: Document usage of frontend plugin and contribution --- Documentation/source/development.rst | 29 ++++++++++++++++++++++++++++ Documentation/source/index.rst | 1 + Documentation/source/usage.rst | 8 ++++++++ 3 files changed, 38 insertions(+) create mode 100644 Documentation/source/development.rst diff --git a/Documentation/source/development.rst b/Documentation/source/development.rst new file mode 100644 index 0000000..0913928 --- /dev/null +++ b/Documentation/source/development.rst @@ -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/ diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst index 5352092..dfda13b 100644 --- a/Documentation/source/index.rst +++ b/Documentation/source/index.rst @@ -13,3 +13,4 @@ Table of Contents concepts connections indexer + development diff --git a/Documentation/source/usage.rst b/Documentation/source/usage.rst index 0c1ea95..1fc0e51 100644 --- a/Documentation/source/usage.rst +++ b/Documentation/source/usage.rst @@ -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*.