Developer Workflow

There are a few common ways to work on Mdoq with Magento, some people simply have one method and stick to it, others swap between depending location/device. (if you’re working from an IPad you can’t really check the repo out locally)

NFS

This is option is only available for clients with an on premise license. Before starting the process you should already have the ‘magento’ drive mounted. If you need assistance with this please contact us.

  1. Create a new instance
  2. Open the directory for your instance, for example if you are working on a Magento 2 project and your instance ID is 1234 and you have the magento drive mounted at /magento the path would be /magento/magento2/1234
  3. You can edit the code and your changes will be reflected as soon as you save the file, no need for git push/pull
  4. Once you finish your work you can git commit and push from the directory you are in using your IDE or from cli. Or you can use Mdoq to Git Push for you.
  5. Follow the “I’m Done” process

Gotchas

  • Because you aren’t committing changes to see them, they won’t be stored in git. This means you need to commit them before recreating the code component.

SFTP Mount

This option requires your device to support SFTP mounts. We have convenience scripts for this please get in touch with us as they are still in their infancy. We would be more then happy to help you use them so we can improve them.

  1. Create a new instance
  2. Enable SFTP for your instance
  3. SFTP Mount using the credentials provided via Mdoq
  4. Open the location you have mounted.
  5. You can edit the code and your changes will be reflected as soon as you save the file, no need for git push/pull
  6. Once you finish your work you can git commit and push from the directory you are in using your IDE or from cli. Or you can use Mdoq to Git Push for you.
  7. Follow the “I’m Done” process

Gotchas

  • Because you aren’t committing changes to see them, they won’t be stored in git. This means you need to commit them before recreating the code component.

SFTP

  1. Create a new instance
  2. Enable SFTP for your instance
  3. Setup an SFTP connection to the instance.
  4. You can edit the code and your changes will be reflected as soon as you save the file (*depending on your SFTP client, programming IDE), no need for git push/pull
  5. Once you finish your work. If your SFTP client/programming IDE allows it you can git commit and push from the directory you are in. Or you can use Mdoq to Git Push for you.
  6. Follow the “I’m Done” process

Gotchas

  • Because you aren’t committing changes to see them, they won’t be stored in git. This means you need to commit them before recreating the code component.

Web Code Editor

  1. Create a new instance
  2. Change code using the web code editor, changes will be reflected immediately.
  3. Once you finish your work you will need to use Mdoq to Git Push for you.
  4. Follow the “I’m Done” process

Gotchas

  • Because you aren’t committing changes to see them, they won’t be stored in git. This means you need to commit them before recreating the code component.

Github / Git

  1. Create a new instance
  2. (optional) if you want to checkout the repo locally git clone [repo url] -b [ticket number]
  3. Edit files in the appropriate branch and commit them to Git.
  4. To see your changes you will have to use Mdoq to Git Pull for you.
    Webhooks (so that Mdoq auto pulls when commits to the appropriate branch are made, are in the roadmap let us know on twitter) if this is something you would like us to prioritise.
  5. Follow the “I’m Done” process

Comparison

Method Fastest access to files Change files without needing to commit to git View log files directly IDE path hinting No need for IDE
NFS
SFTP Mount
SFTP
Web Code Editor
Github/Git