Feature #88947

Link to extension documentation from extension manager

Added by Sybille Peters 3 months ago. Updated 9 days ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
Backend User Interface
Target version:
-
Start date:
2019-08-11
Due date:
% Done:

0%

PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

This was an idea / feature request that was made on Slack a while ago and reappeared during the developer days (requested by someone else).

In general, people often wish for having links to the documentation on docs.typo3.org in the BE.

It should be possible to generate the documentation URL from the information in composer.json, except that not all extensions have documentation on docs.typo3.org (or the extension has already been rerendered with the new mechanism).

https://docs.typo3.org/p/<vendor>/<package name>/master/en-us/

https://docs.typo3.org/p/georgringer/news/master/en-us/

Additionally, this is the file that contains all rendered docs: https://intercept.typo3.com/assets/docs/manuals.json

extensionmanager_news1.png View (17.6 KB) Sybille Peters, 2019-08-13 09:50

extmanager-detail.png View (34.7 KB) Sybille Peters, 2019-08-13 09:51


Related issues

Related to TYPO3 Core - Feature #89458: Show correct manual link in extension manager Resolved 2019-10-19

History

#1 Updated by Christian Hackl 3 months ago

I think this link should be on the list-view (from the getExtension page) and not in the detail-view, because there is a link allready in the detail-view. :)
But why has it to be on "docs.typo3.org"?

#2 Updated by Daniel Siepmann 3 months ago

To not irritate the user, the installed version should be considered. master within URL should be replaced with the concrete version. In case of hosting at docs.typo3.org, only the first two parts of a version are part of URL, see: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocForExtension/Migrate.html#url-structure for information regarding url structure at docs.typo3.org.

#3 Updated by Sybille Peters 3 months ago

@Christian

You're right, the detail view (for example when installing an extension via TER) already shows a link to the Manual: "Read online". But, you cannot get to the detail view from the list, only by selecting "Get extensions", right?

I am currently not sure about the future of the Extension Manager in general as for TYPO3 using Composer is the recommended way to install extensions.

#4 Updated by Sybille Peters 9 days ago

  • Related to Feature #89458: Show correct manual link in extension manager added

#5 Updated by Sybille Peters 9 days ago

  • Status changed from New to Closed

Should now have been fixed with patch https://review.typo3.org/c/Packages/TYPO3.CMS/+/62032

Also available in: Atom PDF