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

Commit 5662a06

Browse files
TASK: Improve documentation
* Add some missing documentation. * Adjust some documentation due to breaking changes. * Adjust structure of documentation for easier changelog rendering and browsing.
1 parent 12c3623 commit 5662a06

24 files changed

Lines changed: 120 additions & 57 deletions

Classes/Command/IndexCommandController.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ public function deleteCommand(string $identifiers)
7272
}
7373

7474
/**
75-
* Will delete the full index for given identifiers.
75+
* Will flush the index for given identifiers from backend.
7676
*
7777
* @param string $identifier Comma separated list of identifiers.
7878
*/
7979
public function flushCommand(string $identifiers = 'pages')
8080
{
8181
$this->executeForIdentifier($identifiers, function (IndexerInterface $indexer) {
8282
$indexer->delete();
83-
$this->outputLine('Indice ' . $indexer->getIdentifier() . ' was deleted.');
83+
$this->outputLine('Indice ' . $indexer->getIdentifier() . ' was flushed.');
8484
});
8585
}
8686

Documentation/source/changelog.rst

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,7 @@ Changelog
22
=========
33

44
.. toctree::
5-
:maxdepth: 1
6-
:glob:
5+
:maxdepth: 2
76

8-
changelog/20181027-added-flush-command
9-
changelog/20181027-allow-multiple-identifiers-on-cli
10-
changelog/20181027-remove-cms7-support
11-
changelog/20180518-75-make-index-name-configurable
12-
changelog/20180424-149-extract-relation-resolver-to-data-processing
13-
changelog/20180410-148-keep-sys_language_uid
14-
changelog/20180315-134-make-conent-fields-configurable
15-
changelog/20180309-25-provide-sys-language-uid
16-
changelog/20180308-131-respect-page-cache-clear
17-
changelog/20180308-introduce-php70-type-hints
18-
changelog/20180306-120-facet-configuration
19-
changelog/20180926-163-allow-zero-as-typoscript-filter-value
20-
changelog/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer
7+
changelog/0.1.0
8+
changelog/0.0.8
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Up till v0.0.8
2+
==============
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
0.0.8/20180306-120-facet-configuration
8+
0.0.8/20180308-131-respect-page-cache-clear
9+
0.0.8/20180308-introduce-php70-type-hints
10+
0.0.8/20180309-25-provide-sys-language-uid
11+
0.0.8/20180315-134-make-conent-fields-configurable
12+
0.0.8/20180410-148-keep-sys_language_uid
13+
0.0.8/20180424-149-extract-relation-resolver-to-data-processing
14+
0.0.8/20180518-75-make-index-name-configurable
15+
0.0.8/20180926-163-allow-zero-as-typoscript-filter-value
16+
0.0.8/20181106-170-do-not-specify-the-pluginname-in-configurationcontainer

Documentation/source/changelog/20180306-120-facet-configuration.rst renamed to Documentation/source/changelog/0.0.8/20180306-120-facet-configuration.rst

File renamed without changes.

Documentation/source/changelog/20180308-131-respect-page-cache-clear.rst renamed to Documentation/source/changelog/0.0.8/20180308-131-respect-page-cache-clear.rst

File renamed without changes.

Documentation/source/changelog/20180308-introduce-php70-type-hints.rst renamed to Documentation/source/changelog/0.0.8/20180308-introduce-php70-type-hints.rst

File renamed without changes.

Documentation/source/changelog/20180309-25-provide-sys-language-uid.rst renamed to Documentation/source/changelog/0.0.8/20180309-25-provide-sys-language-uid.rst

File renamed without changes.

Documentation/source/changelog/20180315-134-make-conent-fields-configurable.rst renamed to Documentation/source/changelog/0.0.8/20180315-134-make-conent-fields-configurable.rst

File renamed without changes.

Documentation/source/changelog/20180410-148-keep-sys_language_uid.rst renamed to Documentation/source/changelog/0.0.8/20180410-148-keep-sys_language_uid.rst

File renamed without changes.

Documentation/source/changelog/20180424-149-extract-relation-resolver-to-data-processing.rst renamed to Documentation/source/changelog/0.0.8/20180424-149-extract-relation-resolver-to-data-processing.rst

File renamed without changes.

0 commit comments

Comments
 (0)