Allow linking to changelog entries from documentation
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`
you could link like so:
And in the Settings.cfg we would need a mapping of 't3changes' to the url.
- 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.
Updated by Tymoteusz Motylewski over 1 year ago
issue on the documentation side https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/issues/110
Updated by Sybille Peters 8 months ago
- Status changed from New to Closed
I think this is now sufficiently handled, see https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/CodingGuidelines.html#link-to-changelog
This is handled, not with :ref: (which would require a header label in the changelog), but with :doc: which requires that you use the path, e.g.
This does have the possible downside, that the link will be broken if the filename changes. This does happen sometimes, but usually not after the Changelog has been moved from master to its final location.
Linking to the changelog as described, requires that t3core is added to Settings.cfg (which has already been done in "TYPO3 EXplained" etc.).