72288[TASK] Improve sysext metadata
Commit message
Review
-
Code review CR +2 Done
- Christian Kuhn +2
- Stefan Bürk +1
-
Verified V +2 Done
- Christian Kuhn +2
- Stefan Bürk +1
- core-ci +1 CI
Issues 1
Files 104
- typo3/sysext/adminpanel/composer.json+1 −1
- typo3/sysext/adminpanel/ext_emconf.php+2 −2
- typo3/sysext/adminpanel/README.rst+5 −5
- typo3/sysext/backend/composer.json3+1 −1
- typo3/sysext/backend/ext_emconf.php+2 −2
- typo3/sysext/backend/README.rstnew+11 −0
- typo3/sysext/belog/composer.json2+1 −1
- typo3/sysext/belog/ext_emconf.php+2 −2
- typo3/sysext/belog/README.rstnew+17 −0
- typo3/sysext/beuser/composer.json2+1 −1
- typo3/sysext/beuser/ext_emconf.php+2 −2
- typo3/sysext/beuser/README.rstnew+18 −0
- typo3/sysext/core/composer.json2+1 −1
- typo3/sysext/core/ext_emconf.php+2 −2
- typo3/sysext/core/README.rstnew+11 −0
- typo3/sysext/dashboard/composer.json2+1 −1
- typo3/sysext/dashboard/ext_emconf.php+2 −2
- typo3/sysext/dashboard/README.rst+5 −3
- typo3/sysext/extbase/composer.json6+1 −1
- typo3/sysext/extbase/ext_emconf.php+2 −2
Show 84 more files
- typo3/sysext/extbase/README.rstnew+13 −0
- typo3/sysext/extensionmanager/composer.json3+1 −1
- typo3/sysext/extensionmanager/ext_emconf.php+2 −2
- typo3/sysext/extensionmanager/README.rstnew+13 −0
- typo3/sysext/felogin/composer.json2+1 −1
- typo3/sysext/felogin/ext_emconf.php+2 −2
- typo3/sysext/felogin/README.rst+4 −4
- typo3/sysext/filelist/composer.json2+1 −1
- typo3/sysext/filelist/ext_emconf.php+2 −2
- typo3/sysext/filelist/README.rstnew+16 −0
- typo3/sysext/filemetadata/composer.json2+1 −1
- typo3/sysext/filemetadata/ext_emconf.php+2 −2
- typo3/sysext/filemetadata/README.rstnew+13 −0
- typo3/sysext/fluid/composer.json2+1 −1
- typo3/sysext/fluid/ext_emconf.php+2 −2
- typo3/sysext/fluid/README.rst+4 −5
- typo3/sysext/fluid_styled_content/composer.json2+1 −1
- typo3/sysext/fluid_styled_content/ext_emconf.php+2 −2
- typo3/sysext/fluid_styled_content/README.rst+4 −4
- typo3/sysext/form/composer.json2+1 −1
- typo3/sysext/form/ext_emconf.php+2 −2
- typo3/sysext/form/README.rst+4 −4
- typo3/sysext/frontend/composer.json2+1 −1
- typo3/sysext/frontend/ext_emconf.php+2 −2
- typo3/sysext/frontend/README.rstnew+11 −0
- typo3/sysext/impexp/composer.json6+1 −1
- typo3/sysext/impexp/ext_emconf.php+2 −2
- typo3/sysext/impexp/README.rst2+5 −4
- typo3/sysext/indexed_search/composer.json6+1 −1
- typo3/sysext/indexed_search/ext_emconf.php+2 −2
- typo3/sysext/indexed_search/README.rst+7 −6
- typo3/sysext/info/composer.json2+1 −1
- typo3/sysext/info/ext_emconf.php+2 −2
- typo3/sysext/info/README.rstnew+14 −0
- typo3/sysext/install/composer.json7+1 −1
- typo3/sysext/install/ext_emconf.php+2 −2
- typo3/sysext/install/README.rstnew+21 −0
- typo3/sysext/linkvalidator/composer.json2+1 −1
- typo3/sysext/linkvalidator/ext_emconf.php+2 −2
- typo3/sysext/linkvalidator/README.rst+9 −7
- typo3/sysext/lowlevel/composer.json2+1 −1
- typo3/sysext/lowlevel/ext_emconf.php+2 −2
- typo3/sysext/opendocs/composer.json4+1 −1
- typo3/sysext/opendocs/ext_emconf.php+2 −2
- typo3/sysext/opendocs/README.rstnew+13 −0
- typo3/sysext/recordlist/composer.json3+1 −1
- typo3/sysext/recordlist/ext_emconf.php+2 −2
- typo3/sysext/recordlist/README.rstnew+13 −0
- typo3/sysext/recycler/composer.json+1 −1
- typo3/sysext/recycler/ext_emconf.php+2 −2
- typo3/sysext/recycler/README.rst+6 −5
- typo3/sysext/redirects/composer.json5+1 −1
- typo3/sysext/redirects/ext_emconf.php+2 −2
- typo3/sysext/redirects/README.rst+5 −5
- typo3/sysext/reports/composer.json+1 −1
- typo3/sysext/reports/ext_emconf.php+2 −2
- typo3/sysext/reports/README.rstnew+13 −0
- typo3/sysext/rte_ckeditor/composer.json2+1 −1
- typo3/sysext/rte_ckeditor/ext_emconf.php+2 −2
- typo3/sysext/rte_ckeditor/README.rst+4 −4
- typo3/sysext/scheduler/composer.json+1 −1
- typo3/sysext/scheduler/ext_emconf.php+2 −2
- typo3/sysext/scheduler/README.rst+4 −4
- typo3/sysext/seo/composer.json4+1 −1
- typo3/sysext/seo/ext_emconf.php+2 −2
- typo3/sysext/seo/README.rst+4 −4
- typo3/sysext/setup/composer.json+1 −1
- typo3/sysext/setup/ext_emconf.php+2 −2
- typo3/sysext/setup/README.rstnew+14 −0
- typo3/sysext/sys_note/composer.json2+1 −1
- typo3/sysext/sys_note/ext_emconf.php+1 −1
- typo3/sysext/sys_note/README.rstnew+14 −0
- typo3/sysext/t3editor/composer.json+1 −1
- typo3/sysext/t3editor/ext_emconf.php+1 −1
- typo3/sysext/t3editor/README.rst+5 −4
- typo3/sysext/tstemplate/composer.json4+1 −1
- typo3/sysext/tstemplate/ext_emconf.php+2 −2
- typo3/sysext/tstemplate/README.rstnew+14 −0
- typo3/sysext/viewpage/composer.json2+1 −1
- typo3/sysext/viewpage/ext_emconf.php+2 −2
- typo3/sysext/viewpage/README.rstnew+14 −0
- typo3/sysext/workspaces/composer.json3+1 −1
- typo3/sysext/workspaces/ext_emconf.php+2 −2
- typo3/sysext/workspaces/README.rst+5 −5
Review log 2637
Show 1012 earlier messages
-
Sybille Peters uploaded patch set 1 11/25/21, 16:30
-
Andreas Kienast commented on patch set 1 11/25/21, 16:39
Why do you have different descriptions in composer.json than in ext_emconf.php? What's the benefit? -
core-ci voted on patch set 1 V +1 11/25/21, 16:40 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19745
-
Sybille Peters commented on patch set 1 11/25/21, 16:43
Reply
No, that was not the intention. In fact my intention was to unified it. The only difference should be that composer.json should use the title AND the description from ext_emconf.php (<title> - <description>). Please point out via comment where there is a difference. -
Mathias Brodala commented on patch set 1 CR -1 11/25/21, 16:57
Please don't be overwhelmed by my comments, I cannot express how much I love that one (you) finally tackles this. Thus I tried to make suggestions which can improve the descriptions even further.composer.json:4This sounds confusing when read together. This IS the TYPO3 backend after all, so maybe we can improve this.composer.json:4Maybe "TYPO3 backend"?composer.json:4"TYPO3 backend"?composer.json:4The "library" should be dropped here since this package is much more than a library.composer.json:4> Module in the TYPO3 backend for configurable dashboards with widgetscomposer.json:4TYPO3 backendcomposer.json:4TYPO3 frontend pluginscomposer.json:4frameworkcomposer.json:4Maybe we can also unify "module", "backend module" and "user interface" (See "Log")?composer.json:4TYPO3 frontendcomposer.json:4See my "module" remark above.composer.json:4> Additional metadata for filescomposer.json:4> the Fluid templating engine I'd avoid the package name here since it can change.composer.json:4> Flexible TYPO3 frontend form framework with TYPO3 backend editorcomposer.json:4See above; this IS the TYPO3 frontend.composer.json:4This really should be shortened; especially the format part can be dropped here IMO since it's not important that early.composer.json:4> as well as files like PDF, Word, HTML and plain text.composer.json:4> pages and recordscomposer.json:4Not sure: didn't we try to avoid abbrev., I mean abbreviations? ;-)composer.json:4> administration and setupcomposer.json:4I'd vote for keeping the term "Install Tool" simply due to the fact that there's still an /install.php. The additional explanation "Admin tools" can be kept as explanation Not sure what the consensus is here.composer.json:4> checks for broken linkscomposer.json:4IMO this part can be dropped. And/or the remaining part shortened.composer.json:4> Open Docs Maybe?composer.json:4TYPO3 backendcomposer.json:4> TYPO3 backendcomposer.json:4> HTTPcomposer.json:4> with optional But TBH this is already too specific IMO, so maybe we can drop this.composer.json:4> for the TYPO3 Backend People continously ask about CKEditor integration for the frontend. We should try to not mislead them that this package does that.composer.json:4> including sitemaps This is so important that it should be mentioned IMO.composer.json:4> System Notes Maybe?composer.json:4> TypoScript Template Maybe?composer.json:4TYPO3 backendcomposer.json:4Explaining "workspaces" with "workspaces" is not that useful IMO. ;-) Maybe we can add a short explanation what workspaces actually are, or rephrase this for "workflows" instead. -
Lina Wolf commented on patch set 1 CR -1 11/25/21, 17:06
Please have a look at my commentscomposer.json:4Actually fluid-styled-content only contains the templates and some css. The content elements themselves are created in EXT:frontend.composer.json:4actually by default it produces XML nowadays.composer.json:4Should we mention the plugin etc? Is is more then just the search enginecomposer.json:4I think it also includes the installer to install a new TYPO3 instance? The 1,2,3 installer?composer.json:4ReplyWhy would you consider the sitemap more important then i.e. metadata...?composer.json:4"for the CMS frontend in." the sentence seems not complete? -
Mathias Brodala commented on patch set 1 11/25/21, 17:07
composer.json:4ReplyI'd not say "more" but "equally". -
Sybille Peters uploaded patch set 2 11/25/21, 18:18
-
Sybille Peters commented on patch set 1 11/25/21, 18:18
First batch. Resolved some comments. Working on next batch ...Reply
No, is cool. Maybe you can also look in the commit message if you agree with the general procedure (e.g. use same texts in ext_emconf and composer.json, always start title with "TYPO3" etc).composer.json:4ReplyAgree. Finding a good phrase for some of these is not so easy. Maybe someone can improve further .... My next idea was "Functionality for administration and editing in the TYPO3 backend." but it is more or less the same, removed it for now - same as in "TYPO3 Frontend".composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyI am not sure what you mean. Maybe you mean sometimes "user interface" is used, sometimes "backend module" etc? So we should always use (preferably) the same terms? But sometimes it is more than just a backend module (e.g. redirects extension, maybe also extension manager and filelist provide more functionality than just a BE module). So rather something generic like TYPO3 backend should be used. And we need to decide on a case by case basis. Problem is, I often don't know exactly if it just a backend module or more. Will fix the other stuff first ... Maybe others can make suggestions.composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyI decided now to remove the additional description entirely. Just writing TYPO3 Frontend in other words is awkward. Describing all the "TYPO3 Frontend" does would be too long and prone to change. Can be changed, if someone has a better idea.composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyNot sure if there is a consensus. I will follow your suggestion.composer.json:4ReplyDonecomposer.json:4Replyok, done. I just remembered this also includes the lowlevel cleaner. I am not aware of the full feature list of this extension.composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyWould it not be helpful to specifically list the module?composer.json:4ReplyActually both are optional, right?composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyAgree. I rephrased it. I will try to get feedback from someone who knows this extension better :) -
core-ci voted on patch set 2 V +1 11/25/21, 18:31 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19751
-
Sybille Peters uploaded patch set 3 11/25/21, 18:42
-
Sybille Peters commented on patch set 2 11/25/21, 18:43
composer.json:4ReplyDonecomposer.json:4ReplyThe description in composer.json was shortened. A longer text now exists in the README.rst and contains XML and t3d.composer.json:4ReplyAgree. Also, "Search engine" is a little misleading, I would usually think of a standalone search engine. Also, as listed in the README.rst, there is also a BE module. So it is indexing functionality, a search plugin and BE module (possibly more). I shortened the text. The longer text is in the README.rst!composer.json:4ReplyI changed "for system administration and setup" to for "installation, upgrade, system administration and setup". I don't know if we have to mention the installer separately, but that could go in the README.rst in the longer description. Please see my changes in the README.rst. Since this extension really offers a lot, it is a little difficult to find a description.composer.json:4ReplyDone
-
Sybille Peters commented on patch set 3 11/25/21, 18:44
composer.json:4ReplyDonecomposer.json:4ReplyDone -
Sybille Peters uploaded patch set 4 11/25/21, 18:47
-
Sybille Peters uploaded patch set 5 11/25/21, 18:49
-
core-ci voted on patch set 3 V +1 11/25/21, 18:55 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19752
-
core-ci voted on patch set 4 V +1 11/25/21, 19:01 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19753
-
Sybille Peters uploaded patch set 6 11/25/21, 19:05
-
core-ci voted on patch set 5 V +1 11/25/21, 19:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19754
-
Sybille Peters uploaded patch set 7 11/25/21, 19:08
-
core-ci voted on patch set 6 V +1 11/25/21, 19:19 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19755
-
core-ci voted on patch set 7 V +1 11/25/21, 19:22 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19756
-
Sybille Peters uploaded patch set 8 11/26/21, 01:44
-
core-ci voted on patch set 8 V +1 11/26/21, 02:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19775
-
Alexander Nitsche commented on patch set 8 CR -1 11/26/21, 09:01
In general i think this is a very good idea to unify the texts here. In particular i checked only EXT:impexp.README.rst:11I would revert the changes in the second sentence and merge both sentences again to become: "Tool for importing and exporting records [in TYPO3] using XML or the custom serialized format T3D." My reasons: 1) I would not put the T3D format in parentheses nor format it like a file extension. It should be completely aligned with XML. 2) The second part of the second phrase is quite redundant as we already said that the tool is importing and exporting records. 3) The second phrase should not start with "Uses ..".composer.json:41) "Tool for importing (..) records from TYPO3." -> would consider to remove "remove TYPO3" as it does not work with import, or make it a neutral "in TYPO3". 2) There are some places in the extension, where the term "Import/Export" is used: will you adjust these too? -
Sybille Peters commented on patch set 8 11/26/21, 09:23
README.rst:11ReplyI have used the suggestion without the [in TYPO3].composer.json:4Reply1) Actually on second thought, I think the "from TYPO3" is redundant. It is vague. And as you pointed out not entirely correct. Will remove. 2) Not scope of patch to change other files. But if this causes too many problems or followup patches we can revert and call it "Import/Export" again instead of "Import & Export" I have changed it. -
Sybille Peters uploaded patch set 9 11/26/21, 09:23
-
core-ci voted on patch set 9 V +1 11/26/21, 09:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19781
-
Alexander Nitsche commented on patch set 9 V +1 CR +1 11/26/21, 09:45
Only checked EXT:impexp. -
Sybille Peters uploaded patch set 10 11/27/21, 16:50
-
Sybille Peters commented on patch set 10 11/27/21, 16:51
composer.json:4ReplySticking with the short variant now: "TYPO3 CMS backend"composer.json:4ReplyRachel mentioned that it might be helpful to see if an extension provides BE modules etc. to see how to enact with it and > The description should also help a end user decide if he/she needs to activate/install the extension via composer or the extension manager, for instance the recycler or the workspaces > What I need to know when I discover an extension is if it provides be modules, fe plugins, services, dashboard widgets, etc. So I decided to specifically list the BE modules and unified this some more.composer.json:4ReplyDonecomposer.json:4ReplyDonecomposer.json:4ReplyChange the text some more: > Create redirects manually, list existing redirects and automatically create redirects on slug changes.composer.json:4ReplyI have now used to documentation https://docs.typo3.org/c/typo3/cms-seo/11.3/en-us/Introduction/Index.html and changed the text some more. -
core-ci voted on patch set 10 V -1 11/27/21, 17:04 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19874
-
core-ci voted on patch set 10 V +1 11/27/21, 17:12 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/19874
-
Christian Kuhn commented on patch set 10 V +1 CR +1 11/27/21, 20:40
nice systematic change. let's get it done! -
Stefan Bürk voted on patch set 10 V +1 CR +1 11/27/21, 20:41
-
Christian Kuhn voted on patch set 10 V +2 CR +2 11/27/21, 22:23
-
Christian Kuhn merged patch set 11 11/27/21, 22:23