Review main Merged

86688[DOCS] Create overview page of minor-release Changelog entries by type

Garvin Hicking CR +2 V +2 Hard +521 −17 updated 10/24/24, 11:52

Commit message

After the release of a LTS version, most people do not care
in which version a deprecation occured, for example.

A new overview page shows the combined features, breaking changes,
deprecations and important notes for a major version on one
page, with a table of contents.

Additionally, ":orphan:" has been removed as it is superfluous.

(Screenshot in forge ticket)

Review

  • Code review CR +2 Done
    • Garvin Hicking +2
    • Anja Leichsenring +1
    • Christian Kuhn +1
  • Verified V +2 Done
    • Garvin Hicking +2
    • Anja Leichsenring +1
    • Christian Kuhn +1
    • core-ci +1 CI

Issues 1

Files 16

Review log 2737

Show 812 earlier messages
  1. Garvin Hicking uploaded patch set 1 10/22/24, 12:59

  2. core-ci voted on patch set 1 V +1 10/22/24, 13:05 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68365

  3. Garvin Hicking uploaded patch set 2 V +1 10/22/24, 13:12

  4. Garvin Hicking uploaded patch set 3 10/22/24, 13:14

  5. core-ci voted on patch set 2 V +1 10/22/24, 13:19 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68366

  6. core-ci voted on patch set 3 V +1 10/22/24, 13:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68367

  7. Chris Müller commented on patch set 3 V -1 10/22/24, 16:18

    Actually, I am receiving warning on rendering, like: app.WARNING: Document Changelog/13.4.x/Important-105007-ManipulationOfFinalSearchQueryInEXTindexed_search has been added to parents Changelog/13.4.x/Index and Changelog-13-combined. The `toctree` directive changes the position of documents in the document tree. Use the `menu` directive to only display a menu without changing the document tree.
  8. Garvin Hicking commented on patch set 3 10/22/24, 16:19

    Reply

    Yes, sorry, this is still WIP. Forgot to tag as such. Needs a new render-guides release and only then 'menu' will work.
  9. Garvin Hicking uploaded patch set 4 V +1 10/22/24, 16:28

  10. Garvin Hicking commented on patch set 4 10/22/24, 16:28

    Reply

    Should render properly now. Added screenshot to issue.
  11. Chris Müller commented on patch set 4 10/22/24, 16:37

    Can you add a TOC to the combined file? Otherwise you have to scroll some screens down to reach, for example, the deprecations. Also I suggest to use "by type" instead of "by kind".
  12. core-ci voted on patch set 4 V +1 10/22/24, 16:38 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68387

  1. Garvin Hicking uploaded patch set 5 V +1 10/22/24, 16:52

  2. Garvin Hicking commented on patch set 5 10/22/24, 16:54

    Reply

    I initially had "by type" but this looked not good to my eyes due. "type" somehow IMO didn't work out for me... I added the toc, good idea.
  3. core-ci voted on patch set 5 V +1 10/22/24, 16:57 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68390

  4. Chris Müller commented on patch set 5 10/22/24, 16:59

    Reply

    Hmm, "kind" does not work for me. Maybe ask Sarah?
  5. Garvin Hicking commented on patch set 5 10/22/24, 18:07

    Reply

    I asked Sarah. Some alternatives: "by category" "by scope" "by impact"
  6. Chris Müller commented on patch set 5 10/22/24, 18:39

    Reply

    scope is nice ;-)
  7. Garvin Hicking commented on patch set 6 V +1 10/22/24, 19:03

    Published edit on patch set 5.
  8. Garvin Hicking commented on patch set 6 10/22/24, 19:04

    Reply

    That works for me then. :-)
  9. Chris Müller updated the commit message in patch set 7 10/22/24, 19:04

  10. core-ci voted on patch set 6 V +1 10/22/24, 19:10 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68397

  11. Garvin Hicking updated the commit message in patch set 8 10/22/24, 19:11

  12. core-ci voted on patch set 7 V +1 10/22/24, 19:11 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68398

  13. core-ci voted on patch set 8 V +1 10/22/24, 19:16 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68399

  14. Sarah McCarthy commented on patch set 8 10/23/24, 08:56

    I would say "by type" because you get different types of code change - breaking, feature, etc.
  15. Chris Müller commented on patch set 8 10/23/24, 18:25

    Reply

    Also fine for me, was my first suggestion ;-)
  16. Mathias Brodala commented on patch set 8 10/24/24, 09:40

    I'd also favor "type" based on these: - https://forger.typo3.com/utilities/rst says "type" - https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/HowTo/UpdateExtensions/ExtensionScanner.html says nothing - https://packagist.org/packages/michielroos/typo3scan says "type" Also I'd suggest this headline/title: > 13.x Changes by type This is shorter, the "all" can be dropped since the minor "x" already implies that. And this way all headlines/links stay aligned.
  17. Garvin Hicking commented on patch set 9 V +1 10/24/24, 09:53

    Published edit on patch set 8.
  18. core-ci voted on patch set 9 V +1 10/24/24, 09:59 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68525

  19. Garvin Hicking uploaded patch set 10 V +1 10/24/24, 10:11

    Also apply to v7 14
  20. Garvin Hicking commented on patch set 10 10/24/24, 10:16

    Reply

    Done
    Thanks for the feedback! Adapted to "type" and applied it to v7-v14.
  21. core-ci voted on patch set 10 V +1 10/24/24, 10:18 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/68527

  22. Christian Kuhn commented on patch set 10 CR +1 V +1 10/24/24, 11:22

    like.
  23. Anja Leichsenring voted on patch set 10 CR +1 V +1 10/24/24, 11:42

  24. Garvin Hicking voted on patch set 10 CR +2 V +2 10/24/24, 11:44

  25. Garvin Hicking merged patch set 11 10/24/24, 11:52