81270[DOCS] Add documentation for sys_note
Commit message
Review
-
Code review CR +2 Done
- Lina Wolf +2
- Chris Müller +1
-
Verified V +2 Done
- Lina Wolf +2
- Chris Müller +1
- core-ci +1 CI
Issues 1
Files 14
- typo3/sysext/sys_note/Documentation/Editor/Index.rst29new+100 −0
- typo3/sysext/sys_note/Documentation/Images/em.pngnewbinary
- typo3/sysext/sys_note/Documentation/Images/sys_note_access.png2newbinary
- typo3/sysext/sys_note/Documentation/Images/sys_note_adding_note.pngnewbinary
- typo3/sysext/sys_note/Documentation/Images/sys_note_backend_formular.png2newbinary
- typo3/sysext/sys_note/Documentation/Images/sys_note_create.pngnewbinary
- typo3/sysext/sys_note/Documentation/Images/sys_note_personal.png2newbinary
- typo3/sysext/sys_note/Documentation/Installation/Index.rst16new+48 −0
- typo3/sysext/sys_note/Documentation/Integrator/Index.rstnew+55 −0
- typo3/sysext/sys_note/Documentation/Introduction/Index.rst4new+19 −0
- typo3/sysext/sys_note/Documentation/Includes.rst.txtnew+34 −0
- typo3/sysext/sys_note/Documentation/Index.rst2new+52 −0
- typo3/sysext/sys_note/Documentation/Settings.cfg2new+66 −0
- typo3/sysext/sys_note/Documentation/Sitemap.rstnew+9 −0
Review log 4156
Show 2331 earlier messages
-
Florian Thiele uploaded patch set 1 09/28/23, 08:45
-
core-ci voted on patch set 1 V +1 09/28/23, 08:57 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47270
-
Florian Thiele updated the commit message in patch set 2
V +109/28/23, 09:00 -
Florian Thiele updated the commit message in patch set 3 09/28/23, 09:02
-
Sarah McCarthy commented on patch set 3 CR -1 09/28/23, 09:10
I'm working on the language -
Stefan Bürk commented on patch set 3 CR -1 09/28/23, 09:10
gitmessage.txt:1This file should not be part of the patch and not in this place. Please remove it. -
core-ci voted on patch set 3 V +1 09/28/23, 09:12 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47273
-
core-ci voted on patch set 2 V +1 09/28/23, 09:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47272
-
Chris Müller commented on patch set 3 09/28/23, 09:45
Index.rst:55I suggest to remove the reference to the index file (and also the genindex file itself) as for this small docs an index would be too much IMHO.Index.rst:22grep sys-noteIndex.rst:38Composer with a capital C (as they spell it themselves).Index.rst:41Composer with a capital C.Index.rst:44I suggest to make the image smaller: Collapse all module groups but the Admin Tools, so the height can be reduced. Additionally, I suggest to avoid real personal names, so adjust your name to something like "John Doe" in the upper right corner (or remove the top bar altogether - this way, the version number is also not visible).Index.rst:13Backend -> backend Please only lines with max. 80 chars for better source readability.Index.rst:15Omit the version number (v12) as this gets outdated very quickly with newer versions.Settings.cfg:29Please use the latest list of manuals and sysext (they were updated some days ago). Have a look into another sysext for this. -
Sarah McCarthy uploaded patch set 4
CR -1V +109/28/23, 11:53 -
core-ci voted on patch set 4 V +1 09/28/23, 12:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47280
-
Chris Müller commented on patch set 4 CR -1 09/28/23, 12:03
Index.rst:12I would avoid :sql: as this is not about the database table but the system extension.Index.rst:13I would avoid :sql: as this is not about the database table but the system extension. Also remove the reference to the version (v12).Index.rst:21Avoid the version (v12). How can I add a note to a record which is not a page? I think, notes can only be added to a page?Index.rst:26Internal = internal?Index.rst:35I suggest to avoid :sep: and :aspect:. Just Instructions <space><space><space>use to provide ... and so on. This will be rendered as a definition list then.Index.rst:52aswell -> as wellIndex.rst:57Please remove the indentation before ".. note::"Index.rst:63Remove :sql: -
Sarah McCarthy commented on patch set 4 CR +1 09/28/23, 12:05
I've add a few changes to Florian's commit -
Chris Müller commented on patch set 4 09/28/23, 12:05
I also suggest to add with this patch the reference to this new extension in all system extension's Settings.cfg file: # ext_sys_note = https://docs.typo3.org/c/typo3/cms-sys-note/main/en-us/ -
Stefan Bürk commented on patch set 4 CR -1 09/28/23, 12:29
-1 gitmessage.txt -
Sarah McCarthy commented on patch set 4 CR -1 09/28/23, 12:33
I am working on this -
Sarah McCarthy uploaded patch set 5
CR -1V +109/28/23, 12:47 -
Sarah McCarthy commented on patch set 5 CR +1 09/28/23, 12:47
Made some of Chris' suggested changesIndex.rst:12ReplyDoneIndex.rst:13ReplyDoneIndex.rst:21ReplyDoneIndex.rst:26ReplyDoneIndex.rst:35ReplyDoneIndex.rst:52ReplyDoneIndex.rst:57ReplyDoneIndex.rst:63ReplyDoneIndex.rst:22ReplyDoneIndex.rst:38ReplyDoneIndex.rst:15ReplyDone -
core-ci voted on patch set 5 V +1 09/28/23, 12:55 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47283
-
Chris Müller commented on patch set 5 CR -1 09/28/23, 14:40
on it -
Chris Müller uploaded patch set 6
CR +1V +109/28/23, 14:55 -
Chris Müller uploaded patch set 7 09/28/23, 14:57
-
Chris Müller commented on patch set 7 09/28/23, 14:57
Reply
Donegitmessage.txt:1ReplyDoneIndex.rst:55ReplyDoneIndex.rst:41ReplyDoneIndex.rst:13ReplyDone -
core-ci voted on patch set 6 V +1 09/28/23, 15:04 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47289
-
core-ci voted on patch set 7 V +1 09/28/23, 15:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47290
-
Chris Müller uploaded patch set 8
V +109/28/23, 16:25 -
Chris Müller commented on patch set 8 09/28/23, 16:25
Index.rst:44ReplyDoneSettings.cfg:29ReplyDone -
Chris Müller commented on patch set 8 09/28/23, 16:26
I there a reason why this isn't merged to 12.4 (at least the "Releases" line lists only "main"). -
Chris Müller commented on patch set 8 09/28/23, 16:27
I like to see some screenshots in the introduction/editors section, at least to visualize the different categories as examples. What do you think? -
Chris Müller commented on patch set 8 09/28/23, 16:29
We should add an Administration/Configuration section to explain that editors must have read and/or write access to the sys_note table. -
core-ci voted on patch set 8 V +1 09/28/23, 16:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/47293
-
Chris Müller commented on patch set 8 09/28/23, 16:37
There is written, for example, "To add a note to a record" ... AFAIK notes can only be added to a page, not to arbitrary records. If so, this should be adjusted. -
Florian Thiele updated the commit message in patch set 9
V +110/26/23, 08:24 -
core-ci voted on patch set 9 V -1 10/26/23, 08:31 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/48212
-
Florian Thiele uploaded patch set 10
V -110/31/23, 09:14 -
core-ci voted on patch set 10 V +1 10/31/23, 09:22 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/48388
-
Andreas Kienast commented on patch set 10 CR -1 10/31/23, 12:34
Index.rst:29"[...] and add [...]" would be the proper term here.Index.rst:34a newIndex.rst:37a newIndex.rst:83Please be neutral to pronouns here. Proposal: "When a backend user opens the corresponding page, a box in which the internal note is displayed can be seen if at least one is available. The various colors represent the different categories."sys_note_access.pngI'd rather have a screenshot that does not include records TYPO3 does not offer by default (tx_otfaq_...).sys_note_backend_formular.pngI'm not sure whether displaying debug field names makes sense if the target audience are editors.sys_note_personal.pngSame concern regarding debug field names as mentioned before.Index.rst:40``` :guilabel:`Extension Manager` module ```Index.rst:44ManagerIndex.rst:47Manager -
Andreas Wolf commented on patch set 10 11/23/23, 18:35
Index.rst:45Used (in all other items as well)Index.rst:57Each category is represented by a distinct icon.Index.rst:83Reply"they" is also a neutral version that would not require a change to the rest of the sentence.Index.rst:20Grep'ing for "sys_note" will not return cms-sys-note. "grep sys-note" should work. -
Florian Thiele uploaded patch set 11
CR -1V +111/30/23, 14:53 -
core-ci voted on patch set 11 V -1 11/30/23, 18:00 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/50171
-
Florian Thiele uploaded patch set 12
V -112/04/23, 16:22 -
Christian Kuhn commented on patch set 12 12/04/23, 17:56
please rebase patch on top of current main to work with new CI. -
Florian Thiele rebased onto patch set 13 12/08/23, 07:53
-
Anja Leichsenring commented on patch set 13 12/08/23, 07:54
Reply
Done -
core-ci voted on patch set 13 V +1 12/08/23, 07:59 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/50473
-
Chris Müller uploaded patch set 14
V +112/08/23, 08:53 -
core-ci voted on patch set 14 V +1 12/08/23, 08:59 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/50477
-
Florian Thiele commented on patch set 14 12/21/23, 15:32
Reply
DoneReply
DoneReply
DoneReply
DoneIndex.rst:29ReplyDoneIndex.rst:34ReplyDoneIndex.rst:37ReplyDoneIndex.rst:45ReplyDoneIndex.rst:57ReplyDoneIndex.rst:83ReplyDonesys_note_access.pngReplyDonesys_note_backend_formular.pngReplyDonesys_note_personal.pngReplyDoneIndex.rst:20ReplyDoneIndex.rst:40ReplyDoneIndex.rst:44ReplyDoneIndex.rst:47ReplyDone -
Chris Müller uploaded patch set 15
V +112/21/23, 17:51 -
Chris Müller commented on patch set 16 12/21/23, 17:53
Published edit on patch set 15. -
core-ci voted on patch set 15 V +1 12/21/23, 17:56 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/50869
-
core-ci voted on patch set 16 V +1 12/21/23, 17:58 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/50870
-
Chris Müller voted on patch set 16 CR +1 V +1 12/21/23, 18:07
-
Lina Wolf commented on patch set 16 CR +2 V +2 12/21/23, 18:11
Thanks a lot for all the work you put into this. Looks good -
Lina Wolf merged patch set 17 12/21/23, 18:11
-
Lina Wolf commented on patch set 17 12/21/23, 18:35
Will late port to 12.4 seems like the Releases line got altered on the way