Task #89330

Allow linking to changelog entries from documentation

Added by Tymoteusz Motylewski 17 days ago. Updated 16 days ago.

Status:
New
Priority:
Should have
Assignee:
-
Category:
Documentation
Target version:
-
Start date:
2019-10-02
Due date:
% Done:

0%

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

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.

History

#1 Updated by Tymoteusz Motylewski 17 days ago

  • Description updated (diff)

#3 Updated by Christian Eßl 16 days ago

  • Category set to Documentation

Also available in: Atom PDF