74873[DOCS] Document reports extension
Commit message
Review
-
Code review CR +2 Done
- Stefan Bürk +2
- Chris Müller +1
- Sybille Peters +1
- Christian Kuhn +1
-
Verified V +2 Done
- Stefan Bürk +2
- Chris Müller +1
- Sybille Peters +1
- core-ci +1 CI
Issues 1
Files 29
- typo3/sysext/reports/Documentation/Api/ExtendedStatusProviderInterface.rst2new+16 −0
- typo3/sysext/reports/Documentation/Api/Index.rstnew+17 −0
- typo3/sysext/reports/Documentation/Api/ReportInterface.rst2new+20 −0
- typo3/sysext/reports/Documentation/Api/RequestAwareReportInterface.rstnew+16 −0
- typo3/sysext/reports/Documentation/Api/RequestAwareStatusProviderInterface.rstnew+16 −0
- typo3/sysext/reports/Documentation/Api/StatusProviderInterface.rst2new+35 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Generated/ExtendedStatusProviderInterface.rst.txtnew+10 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Generated/ReportInterface.rst.txtnew+36 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Generated/RequestAwareReportInterface.rst.txtnew+37 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Generated/RequestAwareStatusProviderInterface.rst.txtnew+19 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Generated/StatusProviderInterface.rst.txtnew+18 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Manual/Autoconfigure.rst.txtnew+6 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Manual/RegisterReport.rst.txtnew+6 −0
- typo3/sysext/reports/Documentation/CodeSnippets/Manual/RegisterStatus.rst.txtnew+0 −0
- typo3/sysext/reports/Documentation/CodeSnippets/codesnippets.phpnew+37 −0
- typo3/sysext/reports/Documentation/CustomReports/Index.rst15new+60 −0
- typo3/sysext/reports/Documentation/CustomReports/Migration.rst4new+131 −0
- typo3/sysext/reports/Documentation/Images/ModuleReports.pngnewbinary
- typo3/sysext/reports/Documentation/Images/SchedulerTask.pngnewbinary
- typo3/sysext/reports/Documentation/Images/Security.pngnewbinary
Show 9 more files
- typo3/sysext/reports/Documentation/Installation/Index.rst8new+29 −0
- typo3/sysext/reports/Documentation/Introduction/Index.rst4new+42 −0
- typo3/sysext/reports/Documentation/Scheduler/Index.rst6new+42 −0
- typo3/sysext/reports/Documentation/genindex.rstnew+7 −0
- typo3/sysext/reports/Documentation/Includes.rst.txtnew+34 −0
- typo3/sysext/reports/Documentation/Index.rst2new+122 −0
- typo3/sysext/reports/Documentation/Settings.cfgnew+63 −0
- typo3/sysext/reports/Documentation/Sitemap.rstnew+9 −0
- typo3/sysext/reports/README.rst+1 −1
Review log 2533
Show 68 earlier messages
-
Lina Wolf uploaded patch set 1 06/11/22, 11:39
-
core-ci voted on patch set 1 V -1 06/11/22, 11:46 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27971
-
Lina Wolf uploaded patch set 2 06/11/22, 11:56
-
core-ci voted on patch set 2 V +1 06/11/22, 12:04 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27972
-
Sybille Peters commented on patch set 2 CR -1 06/11/22, 13:30
review part I (these are mostly some minor spelling things). I am still reviewing.Index.rst:102Use "sent" here - as in "it is sent via email" or "which are sent via email". https://ell.stackexchange.com/questions/219933/which-is-correct-send-or-sentIndex.rst:13I would write "the system extension reports" or "EXT:reports" instead of "the module" here.Index.rst:14I am terrible with punctuation, so I am not sure if a comma should be there, but reading that sentence trips me up. Maybe this: "Therefore, if you installed TYPO3 following Installing TYPO3, the module System Reports is not automatically installed." Not sure if correct that way but eases readabiltiy. Maybe shorten this and simplify it. I think the sentence could also be removed entirely!Index.rst:37modulesIndex.rst:40I would change this to: "In case of a compromised system, the information displayed here may have been manipulated by the attacker." What bothers me a bit in the current sentence is the word "senseless" - it is not so much senseless as incorrect. What is senseless is trying to rely on this output in the case of a compromised system. My suggested sentence is a little more to the point. We might also add the consequence of this, maybe something like this (but I am not sure if this would not be too much): "Thus, if no problems are pointed out - it does not necessarily mean that there are no security issues. But, on the other hand, if security problems are pointed out, you most certainly should fix them." -
Sybille Peters commented on patch set 2 06/11/22, 13:55
Ok, first of all, I love this! And it is great that more system extensions are getting documented. Most of my comments are nitpicks. I am not sure if I can review very well since I am not very familiar with the extension but will try to give it a more thourough review once the nitpicks are out of the way. But I think it should be ok, from what I glanced through; it looks good.ReportInterface.rst:9better: "Classes implementing this interface are registered automatically as reports"StatusProviderInterface.rst:9"are registered automatically"Index.rst:9How can it be "the most prominent" report if it is the only report? Maybe write. "The only report provided by" ...?Index.rst:27Perhaps better: "This, way, the report is automatically registered if autoconfigure" ... - this makes it a bit simpler.Index.rst:49First of all the plural of status should be used here, but shouldn't that be "status provider" instead of status?Index.rst:52I would try to simplify the sentence a little. Such as: "All status providers must implement TYPO3\CMS\Reports\StatusProviderInterface. If autoconfigure is enabled in Services.yaml, the status providers implementing this interface will be automatically registered." (probably this could be improved and simplified even more) - we do not have to say "the interface SomethingInterface" because "implement" and the name SomethingInterface already suggests it is an interface - short simple sentences (hopefully) improve readability. What actually bothered me the most was the phrase "this fact is now used", if not following my suggestion, maybe replace that?Migration.rst:3I think this file is not anywhere in the toctree. I tried to navigate here via the menu and could not.Index.rst:16sent (see previous note)Index.rst:17whether -
Chris Müller commented on patch set 2 06/11/22, 15:48
Index.rst:12plural of status -> statuses See: https://www.macmillandictionary.com/dictionary/american/statusIndex.rst:26In other places you use :php: instead of :any: (custom reports > migration)Index.rst:13Or add a ">" between "System" and "Reports"Index.rst:24Either ", ... the extension "Reports" is already ..." Or ", EXT:reports is already ..." (without the "the")Index.rst:33form -> from -
Lina Wolf uploaded patch set 3 06/11/22, 19:43
-
Lina Wolf commented on patch set 3 06/11/22, 19:43
Index.rst:12ReplyI think status messages is more fitting here then the plural of statusIndex.rst:26Reply:any: links to the phpdomain definition, see https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Phpdomain.html#linking-to-php-entities -
Lina Wolf commented on patch set 3 06/11/22, 19:47
ReportInterface.rst:9ReplyDoneStatusProviderInterface.rst:9ReplyDoneIndex.rst:9ReplyDoneIndex.rst:12ReplyDoneIndex.rst:27ReplyDoneIndex.rst:49ReplyDoneIndex.rst:52ReplyDoneMigration.rst:3ReplyDoneIndex.rst:102ReplyDoneIndex.rst:13ReplyDoneIndex.rst:13ReplyDoneIndex.rst:14ReplyDoneIndex.rst:24ReplyDoneIndex.rst:37ReplyDoneIndex.rst:40ReplyDoneIndex.rst:16ReplyDoneIndex.rst:17ReplyDoneIndex.rst:33ReplyDone -
core-ci voted on patch set 3 V +1 06/11/22, 19:51 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27983
-
Sybille Peters commented on patch set 3 06/12/22, 07:48
Index.rst:26ReplyI do not fully understand this explanation. 1. I looked at the text for the link but it is not obvious to me why :any: is used. Is there no inline code markup such as :php:interface: even though on the "Writing Documentation" page, interface is used to markup a block (.. php:interface::)? 2. Also a link is not created there. Both :php: and :php:class: or :any: produce the same result visually, so it is also not really clear to me what the result should be and what "links to the phpdomain definition" really means and why this is used. I will also open issue in documentation, maybe to clarify that section some more. CORRECTION: A link is created but not styled as link. Maybe you understand my confusion. -
Sybille Peters commented on patch set 3 06/12/22, 07:57
Migration.rst:3ReplyThe toctree is now in Migration.rst, so the file "toctrees" itself. It should be in Index. -
Chris Müller uploaded patch set 4 06/12/22, 09:24
-
Chris Müller uploaded patch set 5 06/12/22, 09:25
-
core-ci voted on patch set 4 V +1 06/12/22, 09:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27989
-
core-ci voted on patch set 5 V +1 06/12/22, 09:33 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27990
-
Lina Wolf uploaded patch set 6 06/12/22, 09:36
-
core-ci voted on patch set 6 V +1 06/12/22, 09:42 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27991
-
Lina Wolf commented on patch set 6 06/12/22, 11:17
Index.rst:26ReplyThe design of the link should be discussed in another place, but I used :php:interface: and the link is working. However the :any: directive is doing the same. If we do not want to use it (and I find it quite useful and easy to remember) we should discuss this in another place.Migration.rst:3ReplyI fixed the toctree there are no more warnings about this. There are only those unpreventable warnings about phpdomain that will be solved once the new rendering container is published. -
Sybille Peters commented on patch set 6 06/12/22, 14:09
ExtendedStatusProviderInterface.rst:11to provide -
Sybille Peters uploaded patch set 7 06/12/22, 14:29
-
Sybille Peters commented on patch set 6 V +1 CR +1 06/12/22, 14:30
ExtendedStatusProviderInterface.rst:11ReplyDone -
Sybille Peters voted on patch set 7 V +1 CR +1 06/12/22, 14:33
-
core-ci voted on patch set 7 V -1 06/12/22, 14:38 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27993
-
Chris Müller uploaded patch set 8 06/12/22, 15:17
-
core-ci voted on patch set 8 V +1 06/12/22, 15:25 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/27994
-
Chris Müller voted on patch set 8 V +1 CR +1 06/12/22, 15:43
-
Sybille Peters voted on patch set 8 V +1 CR +1 06/12/22, 19:35
-
Stefan Bürk voted on patch set 8 V +1 CR +1 06/19/22, 01:40
-
Christian Kuhn voted on patch set 8 CR +1 06/19/22, 01:40
-
Stefan Bürk voted on patch set 8 V +2 CR +2 06/19/22, 01:40
-
Stefan Bürk merged patch set 9 06/19/22, 01:40