Skip to content
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

Update README.md #1225

Open
wants to merge 2 commits into
base: release/next
Choose a base branch
from

Conversation

YevhenZvieriev
Copy link
Contributor

This update adds a detailed section to the README on how to debug Magento 2 cron jobs within a Docker environment using PhpStorm and Xdebug. This information is invaluable for developers who need to troubleshoot and debug scheduled tasks effectively.

  • Simplifies Cron Debugging: Step-by-step instructions make it easier to configure and run debugging for Magento 2 cron jobs.

  • Improves Developer Experience: With clear guidance, developers can save time and avoid common pitfalls during the debugging process.

  • Enhanced Documentation: Having this information in the README provides quick access and ensures all developers working with the repository can easily set up cron debugging.

Copy link

what-the-diff bot commented Sep 20, 2024

PR Summary

  • Introduction of Debugging Guide for Magento 2 Cron Jobs
    An in-depth guide has been incorporated that provides a sequential procedure to debug Magento 2 Cron jobs effectively.

  • Added Illustrations for Configuration Process
    To make the process easier to follow, several images have been included that detail the configuration process for debugging.

  • Inclusion of New Debugging Resource Link
    A new reference link "How to debug Magento 2 Cron jobs" has been appended to the existing list. This will allow users to quickly access debugging resources.

  • Enhanced Setup Instructions
    Detailed instructions have been incorporated for setting up a new PHP script configuration, establishing the interpreter, managing path mappings, determining breakpoints, and operating the debugger.

@YevhenZvieriev
Copy link
Contributor Author

Hi everyone, I have an idea to expand the current README documentation to include a detailed section on how to debug individual Magento 2 cron jobs, rather than just the default cron group.

While we currently have instructions on debugging the default cron group (it works only with the default cron group, honestly I don't know the reason), I recently discovered a way to debug individual cron jobs separately.

This approach could provide developers with more precise control during the debugging process, running only one cronjob, not the entire cron group.

Before I proceed with writing the detailed documentation for this, @markshust I wanted to ask if this would be useful. If so, I can include step-by-step instructions on how to configure PhpStorm and Xdebug to target specific cron jobs, which could improve troubleshooting and efficiency.

@markshust
Copy link
Owner

Thanks @YevhenZvieriev, I absolutely love this contribution!

However, the current README is a mess. It's super long and getting hard to read. I'd like to overhaul it with something like GitHub Pages (ex. https://gibinfrancis.medium.com/creating-structured-multi-page-documentation-with-github-pages-794b100a4941).

If ok, I'll sit on this PR for a bit until the docs are overhauled, but will gladly take stuff like this in, as I think it would make a great contribution to the repo. I think even a new "how to" section where we can place stuff like this in would be an awesome idea.

@markshust
Copy link
Owner

New ticket: #1244

@Nolwennig
Copy link

I'm just passing through here quickly to share this tool: https://readme.so/

@markshust
Copy link
Owner

@Nolwennig very cool -- I wish it did multiple pages!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants