Skip to content
This repository was archived by the owner on Mar 20, 2024. It is now read-only.

Commit 73d61bd

Browse files
FEATURE: Provide more information about concept
1 parent f955a9b commit 73d61bd

File tree

3 files changed

+37
-13
lines changed

3 files changed

+37
-13
lines changed

Documentation/source/concepts.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Concepts
44
========
55

66
The main concept is to provide a foundation where other developers can profit from, to provide
7-
integrations into search services like Elasticsearch, Algolia, ... .
7+
integrations into search services like Elasticsearch, Algolia, …. But also to provide
8+
an ETL Framework.
89

910
Our code contains the following concepts which should be understand:
1011

@@ -18,6 +19,9 @@ interfaces. The main purpose is to provide a stable API between TYPO3 and concre
1819

1920
For information about implementing a new connection, take a look at :ref:`development_connection`.
2021

22+
These are equivalent to "Load" of ETL while "indexing", and equivalent to
23+
"Extraction" in frontend mode.
24+
2125
.. _concepts_indexing:
2226

2327
Indexing
@@ -31,6 +35,8 @@ Currently :ref:`TcaIndexer` and :ref:`PagesIndexer` are provided.
3135

3236
For information about implementing a new indexer, take a look at :ref:`development_indexer`.
3337

38+
This is the process of "loading" data inside the ETL.
39+
3440
.. _concepts_dataprocessing:
3541

3642
DataProcessing
@@ -47,3 +53,5 @@ flexible as integrators are able to configure DataProcessors and change their or
4753
Configuration is done through TypoScript, see :ref:`dataprocessors`.
4854

4955
For information about implementing a new DataProcessor, take a look at :ref:`development_dataprocessor`.
56+
57+
This is the "transforming" step of ETL.

Documentation/source/features.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,16 @@ output.
4646

4747
See :ref:`concepts_dataprocessing` in :ref:`concepts` section.
4848

49+
.. _feature_up_to_you:
50+
51+
Up to you
52+
---------
53+
54+
The following is not provided by default, but possible with custom PHP code:
55+
56+
* Integrating Social Media Feed imports via custom indexer to display feed content
57+
inside of TYPO3 or publishing via custom connections.
58+
4959
.. _features_planned:
5060

5161
Planned

Documentation/source/readme.rst

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,28 @@ Introduction
77
What does it do?
88
----------------
99

10-
The goal of this extension is to provide search integrations into TYPO3 CMS. The extension will
11-
provide a convenient API to allow developers to provide concrete implementations of backends like
12-
Elasticsearch, Algolia or Solr.
10+
Contrary to most search solutions, search_core is an ETL (=Extract, Transform, Load)
11+
Framework. This allows to extract data from one source, transform it, and load them
12+
into an target system. Focusing on search solutions, but not limited to them.
1313

14-
The extension provides integration into TYPO3 like a frontend plugin for searches and hooks to
15-
update search indexes on updates. Also a command line interface is provided for interactions like
16-
re-indexing.
14+
The provided process is to extract data from TYPO3 database storage using TCA, to
15+
transform those data using data processors, and to load them into some search
16+
storage like Elasticsearch. This is done via Hooks and CLI.
17+
18+
Also the process is to extract data from some storage like Elasticsearch, transform
19+
the data using data processors and to load them into the TYPO3 frontend. This is done
20+
via a Frontend Plugin.
1721

1822
Current state
1923
-------------
2024

21-
This is still a very early beta version. More information can be taken from Github at
22-
`current issues`_.
25+
The basic necessary features are already implemented. Still features like workspaces
26+
or multi language are not provided out of the box.
2327

24-
We are also focusing on Code Quality and Testing through `travis ci`_, ``phpcs``, ``phpunit`` and
25-
``phpstan``.
28+
Also only Elasticsearch is provided out of the box as a storage backend. But an
29+
implementation for Algolia is already available via 3rd Party:
30+
https://github.com/martinhummer/search_algolia
2631

27-
.. _current issues: https://github.com/Codappix/search_core/issues
28-
.. _travis ci: https://travis-ci.org/Codappix/search_core
32+
As the initial intend was to provide a common API and implementation for arbitrary
33+
search implementations for TYPO3, the API is not fully implemented for ETL right now.
34+
Also that's the reason for using "search_core" as extension name.

0 commit comments

Comments
 (0)