search

joomla / Manual

Joomla Developer Documentation
28 stars 57 forks source link

Joomla 5 note about MySQL 5.7 #304

Closed Fedik closed 2 weeks ago

Fedik commented 2 months ago

User description

Add a note about MySQL 5.7 to the system requirement page.

Also trying to fix footnotes order. this need to be in another PR

PR Type

documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
technical-requirements.md
Update technical requirements with MySQL 5.7 note and footnotes
docs/get-started/technical-requirements.md
  • Updated footnotes order and content for clarity.
  • Added a note about MySQL 5.7 compatibility and limitations.
  • Corrected a typo in the word "documentation".
    		•  +20/-14 

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 2 months ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Inconsistent Footnote Numbering
    The footnote numbering in the new version is inconsistent with the old version, which may cause confusion for readers. Potential Confusion
    The note about MySQL 5.7 compatibility might be misplaced in the Joomla 5.x requirements section, as it seems more relevant to Joomla 4.x.
    codiumai-pr-agent-pro[bot] commented 2 months ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Security
    Strengthen the warning about using MySQL 5.7 to emphasize security risks and limitations ___ **Consider rephrasing the note about MySQL 5.7 to emphasize the risks more strongly
    and discourage its use more explicitly, while still acknowledging that it can work
    in certain situations.** [docs/get-started/technical-requirements.md [58-61]](https://github.com/joomla/Manual/pull/304/files#diff-552d80425038f200ae721b924cd92b5f043c548342805a47aebb235c69344e46R58-R61) ```diff -[^5]: Although of minimum requirement, Joomla still can work on MySQL 5.7. -We do not recommend, but you could use it if you really stuck in old environment. -Keep in mind, it has a few limitation: update can be done only with manual upload, and the installer will forbid you to process a fresh installation. -Also be aware, MySQL 5.7 reached its official End Of Life and may expose your site to security vulnerabilities. +[^5]: While Joomla can technically work with MySQL 5.7, its use is strongly discouraged due to significant security risks and limitations. MySQL 5.7 has reached its End of Life and may expose your site to vulnerabilities. If you must use it due to environmental constraints, be aware that updates can only be done manually, and fresh installations are not supported. We strongly recommend upgrading to a supported MySQL version as soon as possible. ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion effectively emphasizes the security risks and limitations of using MySQL 5.7, providing a clearer and stronger warning to users, which is crucial for maintaining security standards.
    		9
    Add a clear warning about MySQL 5.7 in the main requirements table ___ **Consider adding a note about the potential security risks of using MySQL 5.7 in the
    main table for Joomla 5.x, rather than only in the footnote. This will make the
    warning more prominent and help users make informed decisions.** [docs/get-started/technical-requirements.md [16]](https://github.com/joomla/Manual/pull/304/files#diff-552d80425038f200ae721b924cd92b5f043c548342805a47aebb235c69344e46R16-R16) ```diff -| [MySQL](https://mysql.com) | 8.1 | 8.0.13[^5] | | +| [MySQL](https://mysql.com) | 8.1 | 8.0.13[^5] | Not recommended: MySQL 5.7 (see note[^5]) | ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: This suggestion improves the visibility of the security risks associated with using MySQL 5.7 by placing a warning directly in the main table, which is beneficial for users making quick decisions based on the table.
    		8
    Enhancement
    Add a link to more information about required PHP modules ___ **Consider adding a brief explanation or link for more information about the json,
    simplexml, dom, zlib, gd, mysqlnd, pdo_mysql, and pdo_pgsql modules mentioned in the
    PHP requirements.** [docs/get-started/technical-requirements.md [14]](https://github.com/joomla/Manual/pull/304/files#diff-552d80425038f200ae721b924cd92b5f043c548342805a47aebb235c69344e46R14-R14) ```diff -| [PHP](https://php.net) | 8.3 | 8.1.0 | Modules: json, simplexml, dom, zlib, gd, mysqlnd or pdo_mysql or pdo_pgsql | +| [PHP](https://php.net) | 8.3 | 8.1.0 | Required modules: json, simplexml, dom, zlib, gd, mysqlnd or pdo_mysql or pdo_pgsql. [More info on modules](https://www.php.net/manual/en/extensions.alphabetical.php) | ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 6 Why: Adding a link for more information about PHP modules is a helpful enhancement for users seeking further details, although it is not critical to the document's primary purpose.
    		6
    HLeithner commented 2 months ago

    I see no need to this comment, we don't support and we don't recommend it and of course we don't test it.