Task #88018
closed
Add Links from Changelog to documentation
0%
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:`)
defragmentdeduplicate- 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):
- How to deal with Changelog becoming main documentation for some new features
- see also several issues on structure in project Content structure
Possible candidates:
Updated by Sybille Peters over 5 years ago
- Related to Task #88005: Refer to different Changelog entry for TYPO3\CMS\Sv\AbstractAuthenticationService in Extension Scanner added
Updated by Gerrit Code Review over 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
Updated by Gerrit Code Review over 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
Updated by Sybille Peters over 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
Updated by Sybille Peters over 5 years ago
See additional comment https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/issues/418#issuecomment-477131657
I will restrict myself to adding links.
Updated by Sybille Peters over 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.
Updated by Susanne Moog almost 5 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.