Task #92196

Do not render all changelogs for all versions

Added by Sybille Peters 3 months ago. Updated 3 months ago.

Status:
Under Review
Priority:
Should have
Category:
Documentation
Target version:
-
Start date:
2020-09-04
Due date:
% Done:

0%

Estimated time:
TYPO3 Version:
11
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

The changelogs are used in the extension scanner etc. so older changelogs must also exist in newer versions.

That does not mean they have to be rendered for every version.

The current practice of rendering all available changelogs has 2 disadvantages:

  1. the rendering takes very long (currently causing it to timeout on the docs server). This makes it more difficult to test changes because you have to wait for the rendering to finish.
  2. changelogs are being rendered multiple times which is not really necessary and results in duplicated content:
    • `https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/7.6.x/Breaking-72931-SearchFormControllerpi_list_browseresultsHasBeenRenamed.html`
    • `https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/8.1/Breaking-72931-SearchFormControllerpi_list_browseresultsHasBeenRenamed.html`

Excluding specific .rst files from rendering can be handled by specifying a jobfile, see https://github.com/t3docs/docker-render-documentation/issues/86

#1

Updated by Sybille Peters 3 months ago

  • Assignee set to Sybille Peters
#2

Updated by Gerrit Code Review 3 months ago

  • Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/65577

#3

Updated by Gerrit Code Review 3 months ago

Patch set 2 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/65577

#4

Updated by Gerrit Code Review 3 months ago

Patch set 3 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/65577

#5

Updated by Gerrit Code Review 3 months ago

Patch set 4 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/65577

#6

Updated by Gerrit Code Review 3 months ago

Patch set 5 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/65577

Also available in: Atom PDF