Task #90806

Create scripts to check for formatting errors in .rst files in Changelog

Added by Sybille Peters 17 days ago.

Status:
New
Priority:
Should have
Assignee:
-
Category:
Documentation
Target version:
-
Start date:
2020-03-22
Due date:
% Done:

0%

TYPO3 Version:
10
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

Currently, there are no automatic checks to check for formatting errors in changelog.

  • There are some checks though that check if the changelog complies to changelog conventions: Build/Scripts/validateRstFiles.php
  • when building the docs, a Documentation-GENERATED-temp/Result/project/0.0.0/_buildinfo/warnings.txt is created, but this does not include some formatting errors which go undetected. However, it will report some problems.
  • there may be other 3rdparty tools available I am not aware of.

Possibly an additional script could be added to check the changelogs for formatting problems.

Apparently, the best practice is using PHP scripts, see Build/Scripts/validateRstFiles.php or ask on Slack.

Problems with lists

Common problem is missing newline before the list. This will not get rendered correctly, see https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Lists.html

You can easily find these with the following command:

cd typo3/sysext/core/Documentation
grep -r -B 1 -E "^(\*|\-) " . | grep "rst-" | grep -v -E "rst-(\*|$|  )" 

grep -r -A 1 -E "^(\*|\-) " . | grep "rst-" | grep -v -E "rst-(\*|$|  )" 

More ...

see https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Index.html

Also available in: Atom PDF