Review main Merged

77169[DOCS] Update TypoScript documentation of Indexed Search

TYPO3com CR +2 V +2 Expert +729 −335 updated 12/21/22, 12:45

Commit message

To update the Indexed Search TypoScript documentation the following tasks
 have been completed:

* Use of `..  confval::` block
* All available settings are named
* Some description texts have been optimized
* Code examples were created
* Indentation was done with 4 spaces
* Heading types were corrected
* Default values were entered separately outside the body text
* Missing references were corrected

Review

  • Code review CR +2 Done
    • Lina Wolf +2
    • Chris Müller +1
    • Benni Mack +1
  • Verified V +2 Done
    • Lina Wolf +2
    • Chris Müller +1
    • Benni Mack +1
    • core-ci +1 CI

Issues 2

Files 1

Review log 1115

  1. TYPO3com uploaded patch set 1 12/15/22, 11:24

  2. Eric Harrer updated the commit message in patch set 2 12/15/22, 11:27

  3. core-ci voted on patch set 2 V +1 12/15/22, 11:42 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/35165

  4. Lina Wolf commented on patch set 2 12/15/22, 11:42

    I ll have a look later
  5. core-ci voted on patch set 1 V +1 12/15/22, 11:42 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/35164

  6. Chris Müller commented on patch set 2 12/15/22, 16:35

    on it
  7. Chris Müller uploaded patch set 3 V +1 12/15/22, 17:04

  8. core-ci voted on patch set 3 V +1 12/15/22, 17:16 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/35176

  9. Chris Müller voted on patch set 3 V +1 CR +1 12/15/22, 17:16

  10. Lina Wolf voted on patch set 3 V +1 CR +1 12/15/22, 18:01

  11. Tymoteusz Motylewski commented on patch set 3 12/19/22, 20:43

    Index.rst:6

    can we make the header more descriptive like "Indexed Search TypoScript configuration" -> this will make it easier to find in the documentation search
  12. Eric Harrer commented on patch set 3 12/20/22, 09:52

    Index.rst:6 Reply

    I think adding "Indexed Search" to the headline would be a duplication as the document is already in the context of the Indexed Search Extension documentation. Searchers will probably already be in this context. I also think "Configuration" in the title is unnecessary, since this page is already a subpage of the "Configuration" page. In addition, the subheading "Plugin Settings" is used in the document and is searchable accordingly. In addition, in the official TYPO3 Extension Manual Template, only the current section is named without the context in the heading. When I use the global search, I end up with at least the first hit on the Indexed Search start page, which contains a sitemap that leads to the TypoScript page. For these reasons, I would keep the title as it is now.
  13. Benni Mack commented on patch set 3 V +1 CR +1 12/21/22, 10:49

    @Lina: Care to merge?
  14. Lina Wolf commented on patch set 3 V +2 CR +2 12/21/22, 12:44

    Index.rst:6 Reply

    Done
  15. Lina Wolf merged patch set 4 12/21/22, 12:45