Task #88018

Add Links from Changelog to documentation

Added by Sybille Peters 6 months ago. Updated 6 months ago.

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

0%

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

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

History

#1 Updated by Sybille Peters 6 months ago

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

#2 Updated by Sybille Peters 6 months ago

  • Description updated (diff)

#3 Updated by Gerrit Code Review 6 months 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

#4 Updated by Gerrit Code Review 6 months 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

#5 Updated by Sybille Peters 6 months ago

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

#6 Updated by Sybille Peters 6 months ago

#7 Updated by Sybille Peters 6 months ago

  • Description updated (diff)

#8 Updated by Sybille Peters 6 months 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.

#9 Updated by Sybille Peters 6 months ago

  • Description updated (diff)

#10 Updated by Sybille Peters 6 months ago

  • Description updated (diff)

Also available in: Atom PDF