Merge pull request #33 from DanielSiepmann/hotfix/fix-installation-docs

CLEANUP: Documentation

Documentation/source/conf.py

@@ -32,6 +32,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.ifconfig',
+    'sphinx.ext.extlinks',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -302,5 +303,10 @@ texinfo_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    't3-tca-ref': ('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: '),
+    'pr': ('https://github.com/DanielSiepmann/search_core/pull/%s', 'Github pull request: '),
+    'issue': ('https://github.com/DanielSiepmann/search_core/issues/%s', 'Github issue: '),
 }

Documentation/source/configuration.rst

@@ -18,7 +18,7 @@ mode of TYPO3. Do so by placing the following line at the end::
 Currently no constants are available, but this will change in the near future to make configuration
 easier.
 
-The strucutre is following TYPO3 Extbase conventions. All settings are placed inside of::
+The structure is following TYPO3 Extbase conventions. All settings are placed inside of::
 
     plugin.tx_searchcore.settings
 
@@ -37,12 +37,19 @@ Options
 The following section contain the different options for e.g.
 ``plugin.tx_searchcore.settings.connection`` or ``plugin.tx_searchcore.settings.index``.
 
+.. warning::
+
+  The structure will change as we need to support multiple indexer and connections.
+  The options will stay the same.
+
+  For further information take a look at :issue:`31`.
+
 .. _configuration_options_connection:
 
 connection
 ^^^^^^^^^^
 
-Holds settings regarding the connection to search service like elasticsearch or solr.
+Holds settings regarding the connection to search service like Elasticsearch or Solr.
 
 Configured as::
 
@@ -63,7 +70,7 @@ Configured as::
 
     Used by: :ref:`Elasticsearch`.
 
-    The host, e.g. ``localhost`` or an ip where the search service is reachable from TYPO3
+    The host, e.g. ``localhost`` or an IP where the search service is reachable from TYPO3
     installation.
 
     Example::
@@ -77,14 +84,13 @@ Configured as::
 
     Used by: :ref:`Elasticsearch`.
 
-    The port where search service is reachable. E.g. default ``9200`` for elasticsearch.
+    The port where search service is reachable. E.g. default ``9200`` for Elasticsearch.
 
     Example::
 
         plugin.tx_searchcore.settings.connection.port = 9200
 
 
-
 .. _configuration_options_index:
 
 index
@@ -111,7 +117,7 @@ Configured as::
 
     Used by: :ref:`TcaIndexer`.
 
-    Defines which TYPO3 tables are allowed to be indexed. Only whitelisted tables will be processed
+    Defines which TYPO3 tables are allowed to be indexed. Only white listed tables will be processed
     through Command Line Interface and Hooks.
 
     Contains a comma separated list of table names. Spaces are trimmed.

Documentation/source/indexer.rst

@@ -12,12 +12,12 @@ The extension provides the following indexer out of the box:
 TcaIndexer
 ----------
 
-Provides zero configuration TYPO3 integration by using the :ref:`t3-tca-ref: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
-implementation is very basic. In future it will also provide mapping for Elasticsearch and further
-stuff.
+implementation is very basic. In future it will also provide mapping for :ref:`Elasticsearch` and
+further stuff.
 
 The indexer is configurable through the following options:
 
@@ -26,3 +26,8 @@ The indexer is configurable through the following options:
 * :ref:`rootLineBlacklist`
 
 * :ref:`additionalWhereClause`
+
+.. note::
+
+  Not all relations are resolved yet, see :issue:`17` and :pr:`20`.
+  Also the `pages`-Table is not available yet, see :issue:`24`.

Documentation/source/installation.rst

@@ -9,6 +9,14 @@ The extension can be installed through composer::
     composer require "leonmrni/search_core dev-feature/integrate-elasticsearch"
 
 or by `downloading`_ and placing it inside the :file:`typo3conf/ext`-Folder of your installation.
+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
+
 
 Afterwards you need to enable the extension through the extension manager and include the static
 typoscript setup.

Documentation/source/readme.rst

@@ -8,7 +8,7 @@ What does it do?
 ----------------
 
 The goal of this extension is to provide search integrations into TYPO3 CMS. The extension will
-abstract the concrete implementations to allow exchange of concrete backends like elasticsearch or
+abstract the concrete implementations to allow exchange of concrete backends like Elasticsearch or
 solr.
 
 The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to
@@ -23,6 +23,8 @@ This is still a very early alpha version. More information can be taken from Git
 
 We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_.
 
+TYPO3 7 is not supported yet, see :project:`1`.
+
 .. _current issues: https://github.com/DanielSiepmann/search_core/issues
 .. _current projects: https://github.com/DanielSiepmann/search_core/projects
 .. _travis ci: https://travis-ci.org/DanielSiepmann/search_core

Documentation/source/usage.rst

@@ -15,9 +15,17 @@ You can trigger indexing from CLI::
 
 This will index the table ``tt_content`` using the :ref:`TcaIndexer`.
 
+Only one table per call is available, to index multiple tables just make multiple calls.
+The tables have to be white listed through :ref:`allowedTables` option.
+
 .. _usage_auto_indexing:
 
 Auto indexing
 -------------
 
-Indexing is done through hooks everytime an record is changed.
+Indexing is done through hooks every time an record is changed.
+The tables have to be white listed through :ref:`allowedTables` option.
+
+.. note::
+
+  Not all hook operations are supported yet, see :issue:`27`.