You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To change the introductory page at https://manual.joomla.org/ to link to sections of the manual which have better content, and avoid linking to sections where content is missing (eg accessibility).
This can be modified in the future as the content in the manual develops.
Because this page is available for all versions, the sections which it links to have to be available for all versions, so I had to copy the module tutorial into 5.0. And because the module tutorial also referenced newer sections, those had to be copied into 5.0 as well. So in the end I just duplicated general-concepts and build-extensions from 5.1 to 5.0. I don't think there's anything in those sections which don't apply to 5.0.
Also I encountered a problem where the subdirectory name is similar to the parent directory name - as in /install-update/install. This was causing broken links to be reported, but strangely only in 5.0. It may be related to facebook/docusaurus#7247.
So I changed the subdirectory name from install to installation, and updated the links in the md files, and it then built ok.
PR Type
Enhancement, Documentation, Formatting
Description
Updated the introductory page to link to sections with better content and avoid linking to sections with missing content.
Updated quick access links and descriptions on the main page.
Reformatted multiple documentation files for consistency and readability.
Added new and expanded documentation for various Joomla extension development topics, including manifest files, update servers, custom scripts, and plugins.
Addressed an issue with broken links by renaming a subdirectory and updating links accordingly.
Changes walkthrough 📝
Relevant files
Enhancement
1 files
index.js
Update quick access links and descriptions.
src/pages/index.js
Updated descriptions for quick access sections.
Changed titles and links for better content navigation.
Replaced 'Components' with 'Tutorials' and updated the icon.
Changed 'Accessibility' to 'Concepts' and updated the icon.
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: 4 🔵🔵🔵🔵⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Key issues to review
Missing Accessibility The updated introductory page lacks links to accessibility resources which were present in the old version. Consider re-adding or updating these resources to maintain accessibility support.
Error Handling The error handling in the FTP plugin could be improved by providing more specific error messages and handling potential exceptions more gracefully to enhance stability and user experience.
Documentation Clarity The documentation in 'manifest.md' could be improved for clarity and completeness, particularly in the sections describing the XML manifest file structure and the update process.
Why: The suggestion correctly identifies and fixes a critical XML tag mismatch error, which is essential for the proper functioning of the manifest file.
10
Best practice
Use constants for URLs to enhance maintainability
Avoid using hardcoded URLs in the JSX. Instead, define them as constants at the top of the file or in a configuration file to make the codebase easier to maintain and update.
Why: Defining URLs as constants improves maintainability and makes the code easier to update. This is a best practice that can significantly enhance the codebase.
9
Replace the error suppression operator with proper error handling
Replace the error suppression operator (@) with proper error handling to avoid hiding potential issues that could affect the stability of the application. Use try-catch blocks to handle exceptions and log errors appropriately.
-if (!$this->ftp_connection = @ftp_connect($this->ftp_server)) {- ...-}-if (!@ftp_login($this->ftp_connection, $this->ftp_username, $this->ftp_password)) {- ...+try {+ $this->ftp_connection = ftp_connect($this->ftp_server);+ if (!$this->ftp_connection) {+ throw new Exception("Failed to connect to FTP server: {$this->ftp_server}");+ }+ if (!ftp_login($this->ftp_connection, $this->ftp_username, $this->ftp_password)) {+ throw new Exception("Failed to login to FTP server: {$this->ftp_server}");+ }+} catch (Exception $e) {+ Log::add("FTP connection error: " . $e->getMessage(), Log::ERROR, 'ftp');+ throw $e;
}
Suggestion importance[1-10]: 9
Why: Replacing the error suppression operator with proper error handling improves code reliability and maintainability by ensuring that errors are not silently ignored and are properly logged and managed.
9
Replace magic numbers with named constants
Avoid using magic numbers directly in the code. Define them as named constants at the beginning of your class to improve code readability and maintainability.
Why: Refactoring repeated code into a separate method reduces duplication, making the code cleaner and easier to maintain.
8
Use a constant for the thumbnail path to facilitate easier updates and configuration
Instead of using a hardcoded path for the thumbnail, consider using a configuration parameter or a constant that can be easily changed without modifying the source code.
Why: The suggestion to change the class name from "icon--3x" to "largeIcon" does improve readability slightly, but the improvement is minor and subjective. The original name is already somewhat descriptive.
5
Enhancement
Use specific HTML tags instead of fragments for better accessibility and SEO
It's recommended to use a more specific tag than the generic fragment <> for wrapping JSX content. This can improve the accessibility and SEO of your page.
-<>+<div>
Learn how Joomla plugins work. Download and install the different example plugins, all with detailed explanations to help you understand what's going on.
-</>+</div>
Apply this suggestion
Suggestion importance[1-10]: 8
Why: Using specific HTML tags instead of fragments can improve accessibility and SEO. This is a good practice and enhances the semantic structure of the HTML.
8
Ensure consistent use of the 'module' attribute in XML tags
Ensure consistency in the use of the 'module' attribute within the 'files' XML tags. The attribute should be consistently used or omitted based on the context provided.
Why: While the suggestion aims to improve consistency, the 'module' attribute is contextually necessary for identifying the module, and removing it may lead to confusion or errors.
5
Security
Use HTTPS in URLs to enhance security
Update the example URL in the tag to use HTTPS for improved security and to avoid potential mixed content issues.
Why: The suggestion enhances security by using HTTPS, which is a best practice for avoiding mixed content issues and ensuring secure communication.
8
Performance
Refactor inline JSX to constants for cleaner code and improved performance
Extract the inline JSX elements to a constant outside the component to clean up the component's body and improve performance by reducing the number of re-renders.
-title: <>Plugins</>,-href: "/docs/building-extensions/plugins/",-iconName: <IconName.BsPlug className="icon--3x" />,-description: (- <>- Learn how Joomla plugins work. Download and install the different example plugins, all with detailed explanations to help you understand what's going on.- </>-),+const pluginSection = {+ title: "Plugins",+ href: "/docs/building-extensions/plugins/",+ iconName: <IconName.BsPlug className="icon--3x" />,+ description: (+ <div>+ Learn how Joomla plugins work. Download and install the different example plugins, all with detailed explanations to help you understand what's going+ </div>+ )+};
Apply this suggestion
Suggestion importance[1-10]: 7
Why: Extracting inline JSX elements to constants can clean up the component's body and potentially improve performance by reducing re-renders. This is a good practice for maintainability.
@HLeithner in this PR I created just 1 file. Then I had to rename/duplicate >100 files to get all the links to work. So the checker was raising lots of issues, from lots of different contributors, many of them on 5.0 which isn't supposed to be maintained anyway.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
qodo-merge-pro
bot
added
documentation
User description
To change the introductory page at https://manual.joomla.org/ to link to sections of the manual which have better content, and avoid linking to sections where content is missing (eg accessibility).
This can be modified in the future as the content in the manual develops.
Because this page is available for all versions, the sections which it links to have to be available for all versions, so I had to copy the module tutorial into 5.0. And because the module tutorial also referenced newer sections, those had to be copied into 5.0 as well. So in the end I just duplicated general-concepts and build-extensions from 5.1 to 5.0. I don't think there's anything in those sections which don't apply to 5.0.
Also I encountered a problem where the subdirectory name is similar to the parent directory name - as in /install-update/install. This was causing broken links to be reported, but strangely only in 5.0. It may be related to facebook/docusaurus#7247.
So I changed the subdirectory name from install to installation, and updated the links in the md files, and it then built ok.
PR Type
Enhancement, Documentation, Formatting
Description
Changes walkthrough 📝
1 files
index.js
Update quick access links and descriptions.src/pages/index.js
6 files
manifest.md
Reformat manifest file documentation for consistency.versioned_docs/version-4.4/building-extensions/install-update/installation/manifest.md
manifest.md
Reformat manifest file documentation for consistency.versioned_docs/version-5.0/building-extensions/install-update/installation/manifest.md
install-process.md
Reformatting of Install Process and Script Files Documentationversioned_docs/version-4.4/building-extensions/install-update/installation/install-process.md
install-process.md
Reformatting of Install Process and Script Files Documentationversioned_docs/version-5.0/building-extensions/install-update/installation/install-process.md
install-process.md
Reformatting of Install Process and Script Files Documentationdocs/building-extensions/install-update/installation/install-process.md
manipulating-forms.md
Reformatting of Manipulating Forms Documentationversioned_docs/version-4.4/general-concepts/forms/manipulating-forms.md
14 files
manifest.md
Add new documentation for manifest files.versioned_docs/version-5.1/building-extensions/install-update/installation/manifest.md
update-server.md
Expand documentation on update servers.versioned_docs/version-5.0/building-extensions/install-update/update-server.md
basic-script.md
Update links and remove TODO note in basic script documentation.versioned_docs/version-5.0/building-extensions/custom-script/basic-script.md
manifest.md
Comprehensive Guide on Joomla Manifest Filesdocs/building-extensions/install-update/installation/manifest.md
administration sections.
filesystem-plugin-ftp.md
Guide to Creating an FTP Filesystem Pluginversioned_docs/version-5.0/building-extensions/plugins/_assets/filesystem-plugin-ftp.md
Joomla.
filesystem-plugin-ftp.md
Guide to Creating an FTP Filesystem Pluginversioned_docs/version-5.0/building-extensions/plugins/filesystem-plugin-ftp.md
Joomla.
logging-on.md
Update Developer Notice Links for Custom Scriptsversioned_docs/version-5.0/building-extensions/custom-script/logging-on.md
plugin documentation within the manual.
index.md
Introduction to Installation and Update of Extensionsversioned_docs/version-5.0/building-extensions/installupdate/index.md
of Joomla extensions.
manifest.md
Detailed Guide on Joomla Manifest Files and Operationsversioned_docs/version-5.0/building-extensions/installupdate/install/manifest.md
files.
metadata, and file management.
SQL operations, and language files.
download keys.
user.md
Comprehensive Overview of Joomla User Class and APIversioned_docs/version-5.0/general-concepts/user.md
Userclass and itsfunctionalities.
determining user status.
User API.
update-server.md
Guide to Setting Up Joomla Extension Update Serversversioned_docs/version-5.0/building-extensions/installupdate/update-server.md
Joomla extensions.
configuring Joomla to use the update server.
scenarios.
filesystem-plugin-basic.md
Tutorial on Creating a Basic Filesystem Plugin for Joomlaversioned_docs/version-5.0/building-extensions/plugins/filesystem-plugin-basic.md
Joomla.
source code examples.
restricted filesystem adapter.
step8-dependency-injection.md
Step-by-Step Guide to Dependency Injection in Joomla Modulesversioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step8-dependency-injection.md
module development.
using service providers.
dispatcher classes.
index.md
Update Developer Notice for Custom PHP Scriptsversioned_docs/version-5.0/building-extensions/custom-script/index.md
an ajax plugin.
58 files
step9-ajax.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step9-ajax.md
...
step5-config.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step5-config.md
...
package.md
...versioned_docs/version-4.4/building-extensions/install-update/installation/package.md
...
package.md
...versioned_docs/version-5.0/building-extensions/install-update/installation/package.md
...
package.md
...docs/building-extensions/install-update/installation/package.md
...
step1-basic-module.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step1-basic-module.md
...
change-log.md
...versioned_docs/version-4.4/building-extensions/install-update/installation/change-log.md
...
change-log.md
...versioned_docs/version-5.0/building-extensions/install-update/installation/change-log.md
...
change-log.md
...docs/building-extensions/install-update/installation/change-log.md
...
ajax-plugin.md
...versioned_docs/version-5.0/building-extensions/plugins/ajax-plugin.md
...
step7-javascript.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step7-javascript.md
...
template-details-file.md
...versioned_docs/version-5.0/building-extensions/templates/template-details-file.md
...
step10_abstract_module_dispatcher.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step10_abstract_module_dispatcher.md
...
step4-languages.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step4-languages.md
...
manipulating-forms.md
...versioned_docs/version-5.0/general-concepts/forms/manipulating-forms.md
...
manipulating-forms.md
...versioned_docs/version-5.1/general-concepts/forms/manipulating-forms.md
...
index.md
...versioned_docs/version-5.0/building-extensions/index.md
...
step6-script-file.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step6-script-file.md
...
install-process.md
...versioned_docs/version-5.1/building-extensions/install-update/installation/install-process.md
...
install-process.md
...versioned_docs/version-5.0/building-extensions/installupdate/install/install-process.md
...
step11_update_server.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step11_update_server.md
...
step2-tmpl-file.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step2-tmpl-file.md
...
package.md
...versioned_docs/version-5.1/building-extensions/install-update/installation/package.md
...
package.md
...versioned_docs/version-5.0/building-extensions/installupdate/install/package.md
...
menus-menuitems.md
...versioned_docs/version-4.4/general-concepts/menus-menuitems.md
...
change-log.md
...versioned_docs/version-5.1/building-extensions/install-update/installation/change-log.md
...
change-log.md
...versioned_docs/version-5.0/building-extensions/installupdate/install/change-log.md
...
menus-menuitems.md
...versioned_docs/version-5.0/general-concepts/menus-menuitems.md
...
menus-menuitems.md
...versioned_docs/version-5.1/general-concepts/menus-menuitems.md
...
step3-helper-file.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/step3-helper-file.md
...
joomla-dialog.md
...versioned_docs/version-5.0/general-concepts/javascript/joomla-dialog.md
...
install.md
...versioned_docs/version-5.0/building-extensions/custom-script/install.md
...
index.md
...versioned_docs/version-4.4/get-started/index.md
...
index.md
...docs/get-started/index.md
...
color-scheme.md
...versioned_docs/version-5.0/building-extensions/templates/color-scheme.md
...
index.md
...versioned_docs/version-5.0/get-started/index.md
...
index.md
...versioned_docs/version-5.1/get-started/index.md
...
index.md
...versioned_docs/version-5.0/general-concepts/index.md
...
index.md
...versioned_docs/version-5.0/building-extensions/modules/module-development-tutorial/index.md
...
step4-languages.md
...versioned_docs/version-4.4/building-extensions/modules/module-development-tutorial/step4-languages.md
...
step4-languages.md
...docs/building-extensions/modules/module-development-tutorial/step4-languages.md
...
step4-languages.md
...versioned_docs/version-5.1/building-extensions/modules/module-development-tutorial/step4-languages.md
...
step1-basic-module.md
...versioned_docs/version-4.4/building-extensions/modules/module-development-tutorial/step1-basic-module.md
...
step6-script-file.md
...versioned_docs/version-4.4/building-extensions/modules/module-development-tutorial/step6-script-file.md
...
step1-basic-module.md
...docs/building-extensions/modules/module-development-tutorial/step1-basic-module.md
...
step6-script-file.md
...docs/building-extensions/modules/module-development-tutorial/step6-script-file.md
...
index.md
...versioned_docs/version-4.4/building-extensions/install-update/installation/index.md
...
index.md
...versioned_docs/version-5.0/building-extensions/install-update/installation/index.md
...
index.md
...docs/building-extensions/install-update/installation/index.md
...
step6-script-file.md
...versioned_docs/version-5.1/building-extensions/modules/module-development-tutorial/step6-script-file.md
...
README.md
...README.md
...
basic-content-plugin.md
...versioned_docs/version-4.4/building-extensions/plugins/basic-content-plugin.md
...
step1-basic-module.md
...versioned_docs/version-5.1/building-extensions/modules/module-development-tutorial/step1-basic-module.md
...
basic-content-plugin.md
...versioned_docs/version-5.0/building-extensions/plugins/basic-content-plugin.md
...
basic-content-plugin.md
...versioned_docs/version-5.1/building-extensions/plugins/basic-content-plugin.md
...
basic-content-plugin.md
...docs/building-extensions/plugins/basic-content-plugin.md
...
index.md
...versioned_docs/version-5.1/building-extensions/install-update/installation/index.md
...
index.md
...versioned_docs/version-5.0/building-extensions/installupdate/install/index.md
...