Review main Merged

74128[DOCS] Align with new TYPO3 documentation standards

Alexander Nitsche CR +2 V +2 Impossible +5834 −5546 updated 04/07/22, 08:48

Commit message

- align README.rst, Index.rst, Includes.txt, Includes.rst.txt,
  Settings.cfg
- add genindex.rst, Sitemap.rst
- remove outdated Targets.rst
- rename Includes.txt to Includes.rst.txt
- reference manual's start page with :doc:`<manual>:Index`

Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.

- replace :ts: with :typoscript: text role

The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.

- fix rendering warnings of EXT:core
- fix rendering warnings of EXT:dashboard
- fix rendering warnings of EXT:fluid_styled_content
- fix rendering warnings of EXT:form
- fix rendering warnings of EXT:linkvalidator

- remove outdated encoding note
- align reST validator at Build/Scripts/validateRstFiles.php

See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html for further details.

Review

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

Issues 1

Files 2906

Show 2886 more files

Review log 2640

Show 915 earlier messages
  1. Alexander Nitsche uploaded patch set 1 03/31/22, 15:59

  2. core-ci voted on patch set 1 V +1 03/31/22, 16:11 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25312

  3. Alexander Nitsche uploaded patch set 2 03/31/22, 17:52

  4. core-ci voted on patch set 2 V +1 03/31/22, 18:04 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25317

  5. Alexander Nitsche uploaded patch set 3 04/01/22, 08:38

  6. Alexander Nitsche uploaded patch set 4 04/01/22, 08:51

  7. core-ci voted on patch set 3 V +1 04/01/22, 08:56 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25329

  8. Alexander Nitsche uploaded patch set 5 04/01/22, 08:59

  9. core-ci voted on patch set 4 V -1 04/01/22, 08:59 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25331

  10. Alexander Nitsche uploaded patch set 6 04/01/22, 09:05

  11. core-ci voted on patch set 5 V -1 04/01/22, 09:13 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25332

  12. core-ci voted on patch set 6 V -1 04/01/22, 09:13 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25333

  13. Alexander Nitsche uploaded patch set 7 04/01/22, 10:19

  14. Alexander Nitsche uploaded patch set 8 04/01/22, 10:23

  15. Alexander Nitsche uploaded patch set 9 04/01/22, 10:30

  1. core-ci voted on patch set 8 V -1 04/01/22, 10:31 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25337

  2. core-ci voted on patch set 7 V -1 04/01/22, 10:33 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25336

  3. core-ci voted on patch set 9 V -1 04/01/22, 10:37 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25338

  4. Alexander Nitsche uploaded patch set 10 04/01/22, 10:37

  5. Alexander Nitsche uploaded patch set 11 04/01/22, 10:46

  6. core-ci voted on patch set 10 V -1 04/01/22, 10:47 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25339

  7. core-ci voted on patch set 11 V -1 04/01/22, 10:56 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25341

  8. Alexander Nitsche uploaded patch set 12 04/01/22, 11:00

  9. Alexander Nitsche uploaded patch set 13 04/01/22, 11:08

  10. core-ci voted on patch set 12 V -1 04/01/22, 11:14 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25342

  11. core-ci voted on patch set 13 V +1 04/01/22, 11:16 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25343

  12. Alexander Nitsche updated the commit message in patch set 14 04/01/22, 11:44

  13. core-ci voted on patch set 14 V +1 04/01/22, 11:54 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25346

  14. Alexander Nitsche commented on patch set 14 04/01/22, 12:01

    No worries: The main part of the changes of the 2907 changed files are due to the change "../Includes.txt" to "/Includes.rst.txt". All extension documentations render fine and no unexpected warnings appear. Interesting for review are these files: 1. sysext/*/README.rst 2. sysext/*/Documentation/Index.rst 3. sysext/*/Documentation/Settings.cfg and especially those: a) @lolli / @benni: should the "ChangeLog" keyword be re-introduced into the documentation of EXT:core? b) @seniors: please check the abstracts in the README.rst of all system extensions but primarly of the newly introduced of - EXT:backend - EXT:core - EXT:frontend c) @seniors: should specific authors be named in the sysext/*/Documentation/Index.rst?
  15. Simon Schaufelberger commented on patch set 14 04/01/22, 12:26

    Settings.cfg:30

    this has been uncommented before. is this correct?
  16. Alexander Nitsche commented on patch set 14 04/01/22, 14:15

    Settings.cfg:30 Reply

    Yes, this was unused.
  17. Simon Schaufelberger wrote 04/01/22, 16:05

    Removed cc Simon Schaufelberger.
  18. Christian Kuhn commented on patch set 14 04/06/22, 09:46

    didn't fully read through this, yet ... hope to find the time for it somewhere next days. questions: * does the changelog rendering in ext:install backend still work well? * does the scanner still find affected .rst files and shows them? * does the scanner still mark "FullyScanned, but you're not affected" docs-files, and are they shown in an own section in ext:install changelog rendering? apart from that, the systematic changes in the changelog files should be reflected in forger, so the forger changelog-kickstarter creates what we want now. this probably needs to be coordinated with typo3-gmbh since forger is not open-sourced.
  19. Alexander Nitsche commented on patch set 14 04/06/22, 10:28

    Reply

    > does the changelog rendering in ext:install backend still work well? yes, i think you mean EXT:core > does the scanner still find affected .rst files and shows them? yes > does the scanner still mark "FullyScanned, but you're not affected" docs-files, and are they shown in an own section in ext:install changelog rendering? yes
  20. Benni Mack voted on patch set 14 CR +1 04/06/22, 11:43

  21. Lina Wolf commented on patch set 14 04/06/22, 18:07

    Admin Tool > Upgrade > Scan Extension Files funktioniert
  22. Lina Wolf commented on patch set 14 V +1 CR +1 04/06/22, 18:33

    * Admin Tool > Upgrade > Scan Extension Files still works and displays errors * Admin Tool > Upgrade > View Upgrade Documentation works fine * Changelog renders fine * Changes look good in code

    Reply

    Done
  23. Lina Wolf voted on patch set 14 V +2 CR +2 04/07/22, 08:18

  24. Lina Wolf merged patch set 15 04/07/22, 08:18

  25. Lina Wolf commented on patch set 15 04/07/22, 08:48

    I accidentally overlooked that one test vote was missing.