Add instructions for using Emulsify with Docksal dev env

[igorlakic]

This is a short "How to" for using Emulsify theme with Docksal development environment.

[amazingrando]

When I run this command I get the following error.

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Installation request for fourkitchens/emulsify ^2.2 -> satisfiable by fourkitchens/emulsify[v2.2].
    - fourkitchens/emulsify v2.2 requires drupal/components ^1.0 -> no matching package found.

Potential causes:
 - A typo in the package name
 - The package is not available in a stable-enough version according to your minimum-stability setting
   see <https://getcomposer.org/doc/04-schema.md#minimum-stability> for more details.

Read <https://getcomposer.org/doc/articles/troubleshooting.md> for further common problems.

Installation failed, deleting ./composer.json.

[igorlakic]

I'm sure that you're not positioned in the project root directory (where the main, Drupal composer.json is located).
If you execute fin exec composer require fourkitchens/emulsify from [PROJECT_ROOT]/web/themes or [PROJECT_ROOT]/web/themes/contrib you'll get this error for sure.

But if you run fin exec composer require fourkitchens/emulsify from the project root directory, everything will be fine.

[amazingrando]

@igorlakic Ah, that would be the issue. Would you update the instructions to reflect that Drupal 8 should already be installed?

[amazingrando]

@igorlakic I'm getting errors while trying to get Drupal 8 set up.

Creating drupal8_db_1 ... error

ERROR: for drupal8_db_1  Cannot start service db: error while mounting volume '/mnt/sda1/var/lib/docker/volumes/drupal8_project_root/_data': error while mounting volume with options: type='none' device='/Users/oest/www/4k/drupal8' o='bind': no such file orCreating drupal8_cli_1 ... error

ERROR: for drupal8_cli_1  Cannot start service cli: error while mounting volume '/mnt/sda1/var/lib/docker/volumes/drupal8_project_root/_data': error while mounting volume with options: type='none' device='/Users/oest/www/4k/drupal8' o='bind': no such file or directory

ERROR: for db  Cannot start service db: error while mounting volume '/mnt/sda1/var/lib/docker/volumes/drupal8_project_root/_data': error while mounting volume with options: type='none' device='/Users/oest/www/4k/drupal8' o='bind': no such file or directory

ERROR: for cli  Cannot start service cli: error while mounting volume '/mnt/sda1/var/lib/docker/volumes/drupal8_project_root/_data': error while mounting volume with options: type='none' device='/Users/oest/www/4k/drupal8' o='bind': no such file or directory
ERROR: Encountered errors while bringing up the project.
Waiting 10s for MySQL to initialize...
 Step 2  Initializing site...
Error response from daemon: Container e5530caa06058e90936d9a7a7cf969902be08cab6103bbc4229bc409ad6c29c1 is not running

[igorlakic]

@amazingrando I can't tell you off the top of my head but you're probably using Vagrant on OSX - there were some issues when Vagrant projects are active in the same time when Docksal VM (Docksal VM image) is also active... I'll try to find a link for that issue later (I'm writing this on a smartphone right now).

EDIT: Maybe this will help

[evanmwillhite]

First of all, thank you @igorlakic for your support in the issue queue and on the DrupalTwig Slack channel! And thanks @amazingrando for testing this. One general comment once you get the kinks worked out is that in the interest of keeping the README as brief as possible, I think this might be better suited for the Wiki installation page (although we could maybe stand to tweak the link verbiage in the README to mention that there are other installation methods on that page).

[amazingrando]

I'll shut down my VMs and retest. Thanks!

[amazingrando]

All my VMs are powered down and I still get the drupal8_db_1 error message above. I'll troubleshoot this on my own later today or tomorrow and return to reviewing this PR once I get that settled.

[amazingrando]

I've tried to get Docksal up and running and can't seem to find the magic combination. I'm going to pass the torch to @evanmwillhite or @ModulesUnraveled to review. I'll set a reminder and if no one has had a chance to review, I'll take another look.

[igorlakic]

Hey @evanmwillhite! Well, we have different opinions, I love to see these kind of instructions straight away on the first/front page of the project (generally speaking). It is true that README wouldn't be as brief as is now and there are pros for that as well. But I respect your opinion as one of the project leaders. Because I like this project and Docksal I made this short "How to" to help other fellow devs. But if you have other plans, no problem at all.

@amazingrando Docksal is really mad at you 😂... I'm using a Linux machine so I don't have such problems 😋 but you might want to look at your /etc/exports file on your macbook. If you use ~/projects dir everything should be fine. If you're using some other dir, then add that location to the /etc/export to match the proper location and run fin vm restart. E.g. if you're using Sites dir:

# <ds-nfs docksal
/Users/YOUR_USER_NAME/Sites 127.0.0.1 192.168.64.100 -alldirs -maproot=0:0
# ds-nfs

and then fin vm restart. But you should definitely read Docksal docs and familiarize yourself better with it. Docksal isn't hard to work with once you understand how it actually works.

[ModulesUnraveled]

I just tried to review this, but unfortunately, I couldn't even get Docksal up and running. So, I'll just leave my general comments here.

1. I'd love to have this type of documentation available in the Wiki. I don't think it's appropriate for the readme, because it's not documenting how to use Emulsify, it's documenting how to use a tool inside Docksal. On top of that, Docksal will only apply to a small percentage of Emulsify users, and I definitely don't want to have docksal, lando, drupalvm, etc. instructions all in one single readme.

I created a stub in the Wiki sidebar for this information (and other environments that might have specific usage instructions). If you will add a new page to the wiki with the Docksal documentation, we'll make sure to link it in the sidebar.

2. Recent updates have made this documentation out-of-date. We no longer have a drush command to create the clone, it's a straight php script due to Drush 9 limitations. So, when you do create the wiki page, please make sure it matches the installation instructions in the latest readme as closely as possible.

Thanks for your work, and for submitting documentation! In my opinion, documentation is the hardest part of maintaining any tool.

[igorlakic]

You're welcome Brian/@ModulesUnraveled!
I really like this theme and it's been a pleasure to write this tutorial for it.

I've made modifications to reflect changes made in Emulsify theme (changed clone command). Can you give me permission to add this to a new page in the wiki?

[ModulesUnraveled]

I think the way to contribute to the Wiki is to clone it, and create a PR just like you would for the regular repo. There's a clone link on the Wiki page below the sidebar: https://github.com/fourkitchens/emulsify/wiki

[igorlakic]

I've already tried that earlier today and got this message:

[ModulesUnraveled]

Bummer! We'll have to figure out another way to allow community contribution to the docs. In the meantime, I went ahead and created the page and mentioned that it was contributed by you.

[igorlakic]

Cool! Thank you Brian!