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

Commit

Permalink
TASK: Improve documentation
Browse files Browse the repository at this point in the history
* Add some missing documentation.
* Adjust some documentation due to breaking changes.
* Adjust structure of documentation for easier changelog rendering and
  browsing.
  • Loading branch information
DanielSiepmann committed Dec 29, 2018
1 parent 12c3623 commit 8c862bc
Show file tree
Hide file tree
Showing 24 changed files with 118 additions and 55 deletions.
4 changes: 2 additions & 2 deletions Classes/Command/IndexCommandController.php
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ public function deleteCommand(string $identifiers)
}

/**
* Will delete the full index for given identifiers.
* Will flush the index for given identifiers from backend.
*
* @param string $identifier Comma separated list of identifiers.
*/
public function flushCommand(string $identifiers = 'pages')
{
$this->executeForIdentifier($identifiers, function (IndexerInterface $indexer) {
$indexer->delete();
$this->outputLine('Indice ' . $indexer->getIdentifier() . ' was deleted.');
$this->outputLine('Indice ' . $indexer->getIdentifier() . ' was flushed.');
});
}

Expand Down
18 changes: 3 additions & 15 deletions Documentation/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,7 @@ Changelog
=========

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

changelog/20181027-added-flush-command
changelog/20181027-allow-multiple-identifiers-on-cli
changelog/20181027-remove-cms7-support
changelog/20180518-75-make-index-name-configurable
changelog/20180424-149-extract-relation-resolver-to-data-processing
changelog/20180410-148-keep-sys_language_uid
changelog/20180315-134-make-conent-fields-configurable
changelog/20180309-25-provide-sys-language-uid
changelog/20180308-131-respect-page-cache-clear
changelog/20180308-introduce-php70-type-hints
changelog/20180306-120-facet-configuration
changelog/20180926-163-allow-zero-as-typoscript-filter-value
changelog/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer
changelog/0.1.0
changelog/0.0.8
18 changes: 18 additions & 0 deletions Documentation/source/changelog/0.0.8.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Up till v0.0.8
==============

.. toctree::
:maxdepth: 1

0.0.8/20180306-120-facet-configuration
0.0.8/20180308-131-respect-page-cache-clear
0.0.8/20180308-introduce-php70-type-hints
0.0.8/20180309-25-provide-sys-language-uid
0.0.8/20180315-134-make-conent-fields-configurable
0.0.8/20180410-148-keep-sys_language_uid
0.0.8/20180424-149-extract-relation-resolver-to-data-processing
0.0.8/20180518-75-make-index-name-configurable
0.0.8/20180926-163-allow-zero-as-typoscript-filter-value
0.0.8/20181027-added-flush-command
0.0.8/20181027-remove-cms7-support
0.0.8/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer
10 changes: 10 additions & 0 deletions Documentation/source/changelog/0.1.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
v0.1.0
======

.. toctree::
:maxdepth: 1

0.1.0/2018-elasticsearch-upgrade
0.1.0/20181027-allow-multiple-identifier-on-cli
0.1.0/20181028-fluid-templating-list-items
0.1.0/20181227-rename-of-configuration-files
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Breaking Change "Elasticsearch Upgrade"
=======================================

By now Elasticsearch v6.x is required in order to work.

You might need to change some configuration, as this is just piped through to
Elasticsearch. Check out the breaking changes of Elasticsearch from 5.x to 6.x.

Also update your Elasticsearch instance.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Breaking Change "Allow multiple identifiers on cli"
===================================================

All CLI commands except a comma separated list of IDs now. Still single IDs are allowed.

Each Identifier will be processed one by another. This is just for continence to not
call the command multiple times with different identifiers.

Spaces are ignored before and after commas.


As the argument was renamed from ``--identifier`` to ``--identifiers``, this is
considered a breaking change.
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Feature "Added fluid partials for list items"
=============================================

When using a separate partial for ListItem you can simply adjust for your custom page type:

Example ListItem.html::
-----------------------
.. code-block:: html
:linenos:

<html xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers"
data-namespace-typo3-fluid="true">

<f:comment>
Add opening for possible different partials based on Document types:
</f:comment>

{f:render(partial: 'resultItem-{result.search_document_type}', arguments: {result: result)}

<f:section name="resultItem-pages">
// Render pages
</f:section>

<f:section name="resultItem-documentType">
// Render custom "documentType"
</f:section>

</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Breaking Change "Configuration files were renamed"
==================================================

TypoScript configuration files now end with ``.typoscript`` instead of ``.txt``.

If you require these files via include statements with full file name, these need to be adjusted.

This file was deleted.

This file was deleted.

4 changes: 2 additions & 2 deletions Documentation/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ The structure is following TYPO3 Extbase conventions. All settings are placed in

Here is the example default configuration that's provided through static include:

.. literalinclude:: ../../Configuration/TypoScript/constants.txt
.. literalinclude:: ../../Configuration/TypoScript/constants.typoscript
:language: typoscript
:caption: Static TypoScript Constants

.. literalinclude:: ../../Configuration/TypoScript/setup.txt
.. literalinclude:: ../../Configuration/TypoScript/setup.typoscript
:language: typoscript
:caption: Static TypoScript Setup

Expand Down
35 changes: 27 additions & 8 deletions Documentation/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,46 @@ Manual indexing

You can trigger indexing from CLI::

./typo3/cli_dispatch.phpsh extbase index:index --identifier 'pages'
./bin/typo3cms index:index --identifier 'pages'
./typo3/cli_dispatch.phpsh extbase index:index --identifiers 'pages'
./bin/typo3cms index:index --identifiers 'pages'

This will index the table ``pages`` using the :ref:`TcaIndexer`.

Only one index per call is available, to run multiple indexers, just make multiple calls.
Multiple indexer can be called by providing a comma separated list of identifiers as
a single argument. Spaces before and after commas are ignored.
The indexers have to be defined in TypoScript via :ref:`configuration_options_index`.

.. _usage_manual_deletion:

Manual deletion
---------------

You can trigger deletion for a single index from CLI::
You can trigger deletion for indexes from CLI::

./typo3/cli_dispatch.phpsh extbase index:delete --identifier 'pages'
./bin/typo3cms index:delete --identifier 'pages'
./typo3/cli_dispatch.phpsh extbase index:delete --identifiers 'pages'
./bin/typo3cms index:delete --identifiers 'pages'

This will delete the index for the table ``pages``.
This will delete the index for the table ``pages``. Deletion means removing all
documents from the index.

Only one delete per call is available, to run multiple deletions, just make multiple calls.
Multiple indices can be called by providing a comma separated list of identifiers as
a single argument. Spaces before and after commas are ignored.

.. _usage_manual_flush:

Manual flush
------------

You can trigger flush for indexes from CLI::

./typo3/cli_dispatch.phpsh extbase index:flush --identifiers 'pages'
./bin/typo3cms index:flush --identifiers 'pages'

This will flush the index for the table ``pages``. Flush means removing the index
from backend.

Multiple indices can be called by providing a comma separated list of identifiers as
a single argument. Spaces before and after commas are ignored.

.. _usage_auto_indexing:

Expand Down

0 comments on commit 8c862bc

Please sign in to comment.