Issue Task Closed

#89330Allow linking to changelog entries from documentation

Tymoteusz Motylewski 10/02/19, 11:12 updated 09/04/20, 12:21

Description

Currently it is not possible to link from documentation (e.g. TYPO3 Explained) to changelog entries.

The documentation team proposed a solution which requires every changelog entry to define a linking target:

.. include:: ../../Includes.txt

.. _Feature-84545-Allow-temporary-files-to-be-stored-outside-the-document-root:

==============================================================================
Feature: #84545 - Allow temporary files to be stored outside the document root
==============================================================================

See :issue:`84545`

THEN
you could link like so:

:ref:`t3changes:Feature-84545-Allow-temporary-files-to-be-stored-outside-the-document-root`

And in the Settings.cfg we would need a mapping of ‘t3changes’ to the url.

TODO:
- add automatic linking target to forger rst generator
- optionally add linking targets to existing rst’s
- add ‘t3changes’ to Settings.cfg of manuals

In the longer run we should include knowledge described in the changelog entries into main documentation (TYPO3 explained/references…), so the question is whether it makes sense to encourage linking to changelog.

Reviews 0

No change resolves or names this issue in its commit message, and no comment links one.