Project

General

Profile

Task #89330

Updated by Tymoteusz Motylewski over 4 years ago

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: 

 <pre> 
 .. 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` 

 </pre> 

 THEN 
 you could link like so: 
 <pre> 
 :ref:`t3changes:Feature-84545-Allow-temporary-files-to-be-stored-outside-the-document-root` 
 </pre> 
 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 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.** changelog.

Back