Review main Merged

81270[DOCS] Add documentation for sys_note

Florian Thiele CR +2 V +2 Hard +383 −0 updated 12/21/23, 18:35

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

Review log 4156

Show 2331 earlier messages
  1. Florian Thiele uploaded patch set 1 09/28/23, 08:45

  2. 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

  3. Florian Thiele updated the commit message in patch set 2 V +1 09/28/23, 09:00

  4. Florian Thiele updated the commit message in patch set 3 09/28/23, 09:02

  5. Sarah McCarthy commented on patch set 3 CR -1 09/28/23, 09:10

    I'm working on the language
  6. Stefan Bürk commented on patch set 3 CR -1 09/28/23, 09:10

    gitmessage.txt:1

    This file should not be part of the patch and not in this place. Please remove it.
  7. 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

  8. 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

  9. Chris Müller commented on patch set 3 09/28/23, 09:45

    Index.rst:55

    I 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:22

    grep sys-note

    Index.rst:38

    Composer with a capital C (as they spell it themselves).

    Index.rst:41

    Composer with a capital C.

    Index.rst:44

    I 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:13

    Backend -> backend Please only lines with max. 80 chars for better source readability.

    Index.rst:15

    Omit the version number (v12) as this gets outdated very quickly with newer versions.

    Settings.cfg:29

    Please use the latest list of manuals and sysext (they were updated some days ago). Have a look into another sysext for this.
  10. Sarah McCarthy uploaded patch set 4 CR -1 V +1 09/28/23, 11:53

  11. 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

  12. Chris Müller commented on patch set 4 CR -1 09/28/23, 12:03

    Index.rst:12

    I would avoid :sql: as this is not about the database table but the system extension.

    Index.rst:13

    I 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:21

    Avoid 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:26

    Internal = internal?

    Index.rst:35

    I 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:52

    aswell -> as well

    Index.rst:57

    Please remove the indentation before ".. note::"

    Index.rst:63

    Remove :sql:
  13. Sarah McCarthy commented on patch set 4 CR +1 09/28/23, 12:05

    I've add a few changes to Florian's commit
  14. 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/
  15. Stefan Bürk commented on patch set 4 CR -1 09/28/23, 12:29

    -1 gitmessage.txt
  16. Sarah McCarthy commented on patch set 4 CR -1 09/28/23, 12:33

    I am working on this
  17. Sarah McCarthy uploaded patch set 5 CR -1 V +1 09/28/23, 12:47

  18. Sarah McCarthy commented on patch set 5 CR +1 09/28/23, 12:47

    Made some of Chris' suggested changes

    Index.rst:12 Reply

    Done

    Index.rst:13 Reply

    Done

    Index.rst:21 Reply

    Done

    Index.rst:26 Reply

    Done

    Index.rst:35 Reply

    Done

    Index.rst:52 Reply

    Done

    Index.rst:57 Reply

    Done

    Index.rst:63 Reply

    Done

    Index.rst:22 Reply

    Done

    Index.rst:38 Reply

    Done

    Index.rst:15 Reply

    Done
  19. 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

  20. Chris Müller commented on patch set 5 CR -1 09/28/23, 14:40

    on it
  21. Chris Müller uploaded patch set 6 CR +1 V +1 09/28/23, 14:55

  22. Chris Müller uploaded patch set 7 09/28/23, 14:57

  23. Chris Müller commented on patch set 7 09/28/23, 14:57

    Reply

    Done

    gitmessage.txt:1 Reply

    Done

    Index.rst:55 Reply

    Done

    Index.rst:41 Reply

    Done

    Index.rst:13 Reply

    Done
  24. 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

  25. 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

  26. Chris Müller uploaded patch set 8 V +1 09/28/23, 16:25

  27. Chris Müller commented on patch set 8 09/28/23, 16:25

    Index.rst:44 Reply

    Done

    Settings.cfg:29 Reply

    Done
  28. 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").
  29. 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?
  30. 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.
  31. 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

  1. 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.
  2. Florian Thiele updated the commit message in patch set 9 V +1 10/26/23, 08:24

  3. 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

  4. Florian Thiele uploaded patch set 10 V -1 10/31/23, 09:14

  5. 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

  6. 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:34

    a new

    Index.rst:37

    a new

    Index.rst:83

    Please 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.png

    I'd rather have a screenshot that does not include records TYPO3 does not offer by default (tx_otfaq_...).

    sys_note_backend_formular.png

    I'm not sure whether displaying debug field names makes sense if the target audience are editors.

    sys_note_personal.png

    Same concern regarding debug field names as mentioned before.

    Index.rst:40

    ``` :guilabel:`Extension Manager` module ```

    Index.rst:44

    Manager

    Index.rst:47

    Manager
  7. Andreas Wolf commented on patch set 10 11/23/23, 18:35

    Index.rst:45

    Used (in all other items as well)

    Index.rst:57

    Each category is represented by a distinct icon.

    Index.rst:83 Reply

    "they" is also a neutral version that would not require a change to the rest of the sentence.

    Index.rst:20

    Grep'ing for "sys_note" will not return cms-sys-note. "grep sys-note" should work.
  8. Florian Thiele uploaded patch set 11 CR -1 V +1 11/30/23, 14:53

  9. 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

  10. Florian Thiele uploaded patch set 12 V -1 12/04/23, 16:22

  11. 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.
  12. Florian Thiele rebased onto patch set 13 12/08/23, 07:53

  13. Anja Leichsenring commented on patch set 13 12/08/23, 07:54

    Reply

    Done
  14. 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

  15. Chris Müller uploaded patch set 14 V +1 12/08/23, 08:53

  16. 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

  17. Florian Thiele commented on patch set 14 12/21/23, 15:32

    Reply

    Done

    Reply

    Done

    Reply

    Done

    Reply

    Done

    Index.rst:29 Reply

    Done

    Index.rst:34 Reply

    Done

    Index.rst:37 Reply

    Done

    Index.rst:45 Reply

    Done

    Index.rst:57 Reply

    Done

    Index.rst:83 Reply

    Done

    sys_note_access.png Reply

    Done

    sys_note_backend_formular.png Reply

    Done

    sys_note_personal.png Reply

    Done

    Index.rst:20 Reply

    Done

    Index.rst:40 Reply

    Done

    Index.rst:44 Reply

    Done

    Index.rst:47 Reply

    Done
  18. Chris Müller uploaded patch set 15 V +1 12/21/23, 17:51

  19. Chris Müller commented on patch set 16 12/21/23, 17:53

    Published edit on patch set 15.
  20. 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

  21. 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

  22. Chris Müller voted on patch set 16 CR +1 V +1 12/21/23, 18:07

  23. 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
  24. Lina Wolf merged patch set 17 12/21/23, 18:11

  25. 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