Project

General

Profile

Actions

Task #88018

closed

Add Links from Changelog to documentation

Added by Sybille Peters about 5 years ago. Updated over 4 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 #1

Updated by Sybille Peters about 5 years ago

  • Related to Task #88005: Refer to different Changelog entry for TYPO3\CMS\Sv\AbstractAuthenticationService in Extension Scanner added
Actions #2

Updated by Sybille Peters about 5 years ago

  • Description updated (diff)
Actions #3

Updated by Gerrit Code Review about 5 years ago

  • Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/60347

Actions #4

Updated by Gerrit Code Review about 5 years ago

Patch set 2 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/60347

Actions #5

Updated by Sybille Peters about 5 years ago

  • Subject changed from Add Links from Changelog to documentation, move information from Changelog to doc to Add Links from Changelog to documentation
Actions #7

Updated by Sybille Peters about 5 years ago

  • Description updated (diff)
Actions #8

Updated by Sybille Peters about 5 years ago

Before I proceed, I think it would be a good idea, to make a general decision about whether links should be added to Changelog:

https://github.com/TYPO3-Documentation/T3DocTeam/issues/76

Additionally, I think it is important to decide on the Changelog in general: should it be the main documentation for new features, which is currently often the case, see

https://github.com/TYPO3-Documentation/T3DocTeam/issues/75

Until this is decided, I will not proceed here.

Actions #9

Updated by Sybille Peters about 5 years ago

  • Description updated (diff)
Actions #10

Updated by Sybille Peters about 5 years ago

  • Description updated (diff)
Actions #11

Updated by Susanne Moog over 4 years ago

  • Status changed from Under Review to Closed

As the review is abandoned I'm also closing the issue for now. Can be revisited once the github discussion is done.

Actions

Also available in: Atom PDF