diff --git a/Documentation/source/index.rst b/Documentation/source/index.rst index 40ba743..5352092 100644 --- a/Documentation/source/index.rst +++ b/Documentation/source/index.rst @@ -1,33 +1,4 @@ -TYPO3 Extension search_core's documentation! -============================================ - -Introduction -============ - -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 -solr. - -The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to -update search indexes on updates. Also a command line interface is provided for interactions like -reindexing. - -Current state -------------- - -This is still a very early alpha version. More information can be taken from Github at -`current issues`_ and `current projects`_. - -We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_. - -.. _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 -.. _scrutinizer: https://scrutinizer-ci.com/g/DanielSiepmann/search_core/inspections -.. _codacy: https://www.codacy.com/app/daniel-siepmann/search_core/dashboard +.. include:: readme.rst Table of Contents ================= diff --git a/Documentation/source/readme.rst b/Documentation/source/readme.rst new file mode 100644 index 0000000..2c5e419 --- /dev/null +++ b/Documentation/source/readme.rst @@ -0,0 +1,31 @@ +TYPO3 Extension search_core's documentation! +============================================ + +Introduction +============ + +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 +solr. + +The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to +update search indexes on updates. Also a command line interface is provided for interactions like +reindexing. + +Current state +------------- + +This is still a very early alpha version. More information can be taken from Github at +`current issues`_ and `current projects`_. + +We are also focusing on Code Quality and Testing through `travis ci`_, `scrutinizer`_ and `codacy`_. + +.. _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 +.. _scrutinizer: https://scrutinizer-ci.com/g/DanielSiepmann/search_core/inspections +.. _codacy: https://www.codacy.com/app/daniel-siepmann/search_core/dashboard + diff --git a/readme.rst b/readme.rst new file mode 120000 index 0000000..070efe4 --- /dev/null +++ b/readme.rst @@ -0,0 +1 @@ +Documentation/source/readme.rst \ No newline at end of file