Project

General

Profile

Actions

Task #88018

closed

Add Links from Changelog to documentation

Added by Sybille Peters over 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Should have
Category:
Documentation
Target version:
-
Start date:
2019-03-27
Due date:
% Done:

0%

Estimated time:
TYPO3 Version:
9
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

Changelogs are really useful and often provide the best description of new features. But the information is quite fragmented and I think it would be useful, if we add more links to main documentation and possibly move some of the information from the changelog to the main documentation.

I'd like to do the following:

  • Add links to main documentation
  • Add links to related Changelog
  • in some cases, move information from Changelog to main documentation

I am following the following concepts / best practices:

  • Do not use absolute URLs, use intersphinx linking mechanism (`:ref:`)
  • defragment
  • deduplicate
  • if possible, have one main entry point for a topic
  • use links
  • direct people to main source of documentation. For core information, this is usually "TYPO3 Explained" or one of the references.

Related (in docs):

Possible candidates:


Related issues 1 (0 open1 closed)

Related to TYPO3 Core - Task #88005: Refer to different Changelog entry for TYPO3\CMS\Sv\AbstractAuthenticationService in Extension Scanner Closed2019-03-26

Actions
Actions

Also available in: Atom PDF