Skip to content

Unified all headers in migrations section as title case. #477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 30, 2025

Conversation

muhme
Copy link
Contributor

@muhme muhme commented May 30, 2025

User description

Plus:

  • Added missing page headers # (level 1)
  • Removed level 5 ##### (used for text formating)
  • Unified using ## for level 2 formating (instead ----)
  • Changed second (and more) # subheadings to ## (importand, else they are not shown in TOC!)
  • Changed #### to ##, where no ## or ### exist
  • moving ### to ##, where no ## exist
  • some ## inserted for better ordering
  • Mostly only in the headers:
    • Sometimes backticks inserted for objects
    • Sometimes English language style slightly adapted
  • Removed some 'has not been released yet' developer notes for released versions
    • Note: Further adjustments are required for already published versions
  • Changed from the super short e.g. ‘5.3 to 5.4’ to longer ‘Joomla 5.3 to 5.4 Upgrade Notes’ (if the page is a link target, the not-so-familiar reader may wonder where I am) plus using title to make the menu entry short again
  • 'my' 5.4 'New Deprecations' rewritten

PR Type

Documentation


Description

  • Standardized all migration guide headers to Title Case

  • Unified heading levels for consistency and TOC accuracy

  • Added or corrected missing and inconsistent page titles

  • Improved English style and clarity in migration docs


Changes walkthrough 📝

Relevant files
Documentation
46 files
index.md
Standardized headings and added explicit page title           
+4/-4     
new-deprecations.md
Standardized headings to Title Case                                           
+2/-2     
new-features.md
Standardized headings to Title Case                                           
+2/-2     
removed-backward-incompatibility.md
Standardized headings to Title Case                                           
+2/-2     
index.md
Standardized headings and added explicit page title           
+3/-2     
new-deprecations.md
Standardized headings to Title Case                                           
+1/-1     
new-features.md
Standardized headings to Title Case                                           
+1/-1     
removed-backward-incompatibility.md
Added missing main heading and standardized subheadings   
+6/-3     
index.md
Standardized headings and added explicit page title           
+3/-2     
new-deprecations.md
Standardized headings to Title Case                                           
+1/-1     
new-features.md
Standardized headings to Title Case                                           
+1/-1     
removed-backward-incompatibility.md
Standardized headings to Title Case                                           
+1/-1     
index.md
Standardized headings and added explicit page title           
+3/-2     
layout-changes.md
Standardized headings to Title Case and heading levels     
+2/-3     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+6/-6     
new-features.md
Standardized headings to Title Case                                           
+1/-1     
removed-backward-incompatibility.md
Standardized headings to Title Case                                           
+1/-1     
index.md
Standardized headings and added explicit page title           
+3/-2     
new-deprecations.md
Standardized headings to Title Case and improved clarity 
+7/-7     
new-features.md
Standardized headings to Title Case and improved clarity 
+3/-2     
removed-backward-incompatibility.md
Standardized headings to Title Case and improved clarity 
+4/-4     
compat-plugin.md
Standardized headings to Title Case and heading levels     
+6/-5     
index.md
Standardized headings and added explicit page title           
+6/-4     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+5/-4     
new-features.md
Standardized headings to Title Case                                           
+2/-1     
removed-backward-incompatibility.md
Standardized headings to Title Case and improved clarity 
+55/-51 
index.md
Standardized headings and added explicit page title           
+5/-3     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+7/-6     
new-features.md
Standardized headings to Title Case and heading levels     
+5/-4     
removed-backward-incompatibility.md
Standardized headings to Title Case and heading levels     
+2/-1     
compat-plugin.md
Standardized headings to Title Case and heading levels     
+3/-2     
index.md
Standardized headings and added explicit page title           
+3/-1     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+5/-5     
new-features.md
Standardized headings to Title Case and heading levels     
+4/-3     
compat-plugin.md
Standardized headings to Title Case and heading levels     
+3/-2     
index.md
Standardized headings and added explicit page title           
+4/-2     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+11/-15 
new-features.md
Standardized headings to Title Case and heading levels     
+7/-6     
index.md
Standardized headings and added explicit page title           
+3/-1     
new-deprecations.md
Standardized headings to Title Case and improved clarity 
+16/-14 
new-features.md
Standardized headings to Title Case and heading levels     
+5/-4     
compat-plugin.md
Standardized headings to Title Case and heading levels     
+5/-4     
index.md
Standardized headings and added explicit page title           
+3/-1     
new-deprecations.md
Standardized headings to Title Case and heading levels     
+2/-1     
new-features.md
Standardized headings to Title Case and heading levels     
+3/-2     
removed-backward-incompatibility.md
Standardized headings to Title Case and improved clarity 
+27/-26 

Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • - Added missing page headers # (level 1)
    - Removed level 5 ##### (used for text formating)
    - Unified using ## for level 2 formating (instead ----)
    - Changed second (and more) # subheadings to ## (importand, else they are not shown in TOC!)
    - Changed #### to ##, where no ## or ### exist
    - moving ### to ##, where no ## exist
    - some ## inserted for better ordering
    - Mostly only in the headers:
      - Sometimes backticks inserted for objects
      - Sometimes English language style slightly adapted
    - Removed some 'has not been released yet' developer notes for released versions
      - Note: Further adjustments are required for already published versions
    - Changed from the super short e.g. ‘5.3 to 5.4’ to longer ‘Joomla 5.3 to 5.4 Upgrade Notes’
      (if the page is a link target, the not-so-familiar reader may wonder where I am)
      plus using `title` to make the menu entry short again
    - 'my' 5.4 'New Deprecations' rewritten
    Copy link
    Contributor

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Formatting Inconsistency

    Some backticks are missing around file extensions and technical terms. For example, .tar.bz2 and .tar.zstd should be consistently formatted with backticks as shown in other sections.

    ## Replacing `.tar.bz2` with `.tar.zstd`
    
    Starting with the final release of Joomla! 5.0.0 we no longer create `.tar.bz2` packages. Instead we use `.tar.zstd` packages.
    This allows us to create download packages which are about 3 MiB smaller then bzip2 compressed files and about 11 MiB smaller
    files then zip compressed files.
    Missing Title

    The page has a heading "New Deprecations" but is missing the # symbol to make it a proper level 1 heading, unlike other similar files that have been updated with proper heading formatting.

    New Deprecations
    ================

    Copy link
    Contributor

    qodo-merge-pro bot commented May 30, 2025

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix formatting and typo
    Suggestion Impact:The commit fixed the typo by changing 'distributiong' to 'distributing' as suggested

    code diff:

    -- Descriptions: The build tools won't produce `es5.js` files (IIFE, transpiled to ES5) anymore. Further more the dependencies in all the assets.json files that were pointing to these (es5) files were removed (the actual entries for the -es5.js were kept for B/C but the URLs are empty, the files won't be loaded). The .es6.js files are transpiled to ES2018 and specifically the minimum browser versions are the ones from [caniuse: es6-module](https://caniuse.com/es6-module). 3rd PD code that used the `type=module`/`nomodule` to load modern/legacy code will still work as it did before but the core is not distributiong anymore `IE11` compatible scripts!
    +- Descriptions: The build tools won't produce `es5.js` files (IIFE, transpiled to ES5) anymore. Further more the dependencies in all the assets.json files that were pointing to these (es5) files were removed (the actual entries for the -es5.js were kept for B/C but the URLs are empty, the files won't be loaded). The .es6.js files are transpiled to ES2018 and specifically the minimum browser versions are the ones from [caniuse: es6-module](https://caniuse.com/es6-module). 3rd PD code that used the `type=module`/`nomodule` to load modern/legacy code will still work as it did before but the core is not distributing anymore `IE11` compatible scripts!

    There's a stray period character at the end of the paragraph that should be
    removed. Also, there's a typo in "distributiong" which should be "distributing".

    migrations/44-50/removed-backward-incompatibility.md [50]

     ### Drop -es5.js files
     - PR: https://github.com/joomla/joomla-cms/pull/39618
    -- Descriptions: The build tools won't produce es5 files (IIFE, transpiled to ES5) anymore. Further more the dependencies in all the assets.json files that were pointing to these (es5) files were removed (the actual entries for the -es5.js were kept for B/C but the URLs are empty, the files won't be loaded). The .es6.js files are transpiled to ES2018 and specifically the minimum browser versions are the ones from [caniuse: es6-module](https://caniuse.com/es6-module). 3rd PD code that used the `type=module`/`nomodule` to load modern/legacy code will still work as it did before but the core is not distributiong anymore `IE11` compatible scripts!
    -.
    +- Descriptions: The build tools won't produce es5 files (IIFE, transpiled to ES5) anymore. Further more the dependencies in all the assets.json files that were pointing to these (es5) files were removed (the actual entries for the -es5.js were kept for B/C but the URLs are empty, the files won't be loaded). The .es6.js files are transpiled to ES2018 and specifically the minimum browser versions are the ones from [caniuse: es6-module](https://caniuse.com/es6-module). 3rd PD code that used the `type=module`/`nomodule` to load modern/legacy code will still work as it did before but the core is not distributing anymore `IE11` compatible scripts!

    [To ensure code accuracy, apply this suggestion manually]

    Suggestion importance[1-10]: 4

    __

    Why: The suggestion correctly identifies a typo ("distributiong" should be "distributing"), but the existing_code format doesn't exactly match the PR's heading structure. The typo fix is valid and improves readability.

    Low
    • Update

    @muhme
    Copy link
    Contributor Author

    muhme commented May 30, 2025

    Qodo findings fixed, backticks are nonsense - I think - and level 1 titles are intended with ===.

    Copy link
    Member

    @HLeithner HLeithner left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Can you please also fix the other h1 ==== which doesn't align correct and always make a blank line between headline and text please?

    muhme and others added 4 commits May 30, 2025 15:29
    Co-authored-by: Harald Leithner <leithner@itronic.at>
    Co-authored-by: Harald Leithner <leithner@itronic.at>
    Co-authored-by: Harald Leithner <leithner@itronic.at>
    @muhme
    Copy link
    Contributor Author

    muhme commented May 30, 2025

    Can you please also fix the other h1 ==== which doesn't align correct and always make a blank line between headline and text please?

    null problemo, done

    @HLeithner HLeithner merged commit 497e98f into joomla:main May 30, 2025
    2 checks passed
    @HLeithner
    Copy link
    Member

    thx

    @muhme muhme deleted the migrations-unified-title-case branch May 30, 2025 16:53
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants