Issue Task Closed

#83325Optimize Core Changelog documentation

Martin Bless 12/14/17, 14:04 updated 10/02/18, 10:53

Description

The optimization proposed here is independent of the current discussion at https://decisions.typo3.org/t/core-changelog-documentation-workflow-revised/334

It can be activated right away.

It is inspired by the (appreciated) proposal of the discussion and seems necessary to avoid unbearable long processing times for rendering the documentation.

*Problem:*
Rendering of sysext:core documentation (ChangeLog!) takes as considerable amount of time. This may soon become VERY inconvenient if ChangeLogs get longer and longer since they are accumulated in ‘master’ reflecting all versions.

*Solution:*
We do a slightly different nesting (“importing”) of the documentation files. And we mark some files as “:orphan:”.

Benefits:

  • For example, dropping a single line can skip the rendering of all v8 files. No warnings occur in that case.
  • Dropping a single line for v7, v8, v9 would simliarly suppress rendering of those files. So only the current ‘master’ cangelogs are rendered.
  • Local rendering, with the Docker container for example, would then only take seconds in contrast to 15 minutes or more
  • the documentation in the frontend will have a better and consistent hierarchy
  • incoming RST-docfiles are “sorted” into the documentation in the correct manny right from the start and can easily be move to, for example a “9.2” folder.

A patch will follow.

Reviews 1