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

Adds documentation for the Docksal environment #3222

Closed
wants to merge 4 commits into from

Conversation

shelane
Copy link
Contributor

@shelane shelane commented Nov 7, 2018

I wasn't sure which branch to propose the PR for. It's here for 9.2.x, but should certainly be included in 10.0.x also.

At the request of @mikemadison13, I put together this documentation page on using BLT in the Docksal environment. I had a little help from @lpeabody in the direction of what should be included in this page.

```
4. setup your Drupal site
```
fin blt setup -D setup.strategy=install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would elaborate on what setup.strategy means here. By default, passing this option is not required since BLT defaults to the install strategy.

Maybe specify something along the lines of:

Alternatively, you may use a sync setup strategy if there is an existing remote with a source database to used in a Drush sql:sync operation:

fin blt setup -D setup.strategy=sync

```
options:
uri: 'http://myproject.docksal'
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, reconsidering my above comment on using setup.strategy=sync, it's probably better to add that to this section. I would document it as such:

  1. Assuming your site's drush remote is @sitegroup.siteid then you can update your BLT configuration (either at the project level or site level):

At the project level (blt/blt.yml) or site level (e.g. sites/default/blt.yml):

setup:
  strategy: sync

drush:
  aliases:
    remote: sitegroup.siteid

So when setting up the project for the first time when running fin blt setup it will execute the sync setup strategy rather than the install strategy (sql:sync vs site:install), effectively executing drush sql:sync @sitegroup.siteid @self.

@mikemadison13 mikemadison13 added Enhancement A feature or feature request documentation labels Nov 7, 2018
@mikemadison13
Copy link
Contributor

We should also add a link to https://blt.readthedocs.io/en/latest/local-development/#alternative-local-development-environments that links to Docksal as well as Lando (and perhaps take the opportunity to fix the broken markup for the Lando link that's there too!)

Thanks @shelane for taking time to put this together

@shelane
Copy link
Contributor Author

shelane commented Nov 19, 2018

@mikemadison13 I added the link on the local development page and fixed the markup.

@mikemadison13
Copy link
Contributor

@shelane can you have a look and respond to @lpeabody's comments above? i'm not sure i've ever passed an argument into blt setup before, not sure how that would be needed in this context?

@lpeabody
Copy link
Contributor

@mikemadison13 technically speaking you don't need to pass arguments. Setup strategy is not unique to Docksal obviously, so documenting it here is probably out of scope (BLT would be well served to highlight setup strategy elsewhere in the documentation for sure), but altering the setup strategy (valid strategies being install, sync, and import) has been an indispensable tool to use in our CI processes which also run through Docksal.

To that point, I think it's relevant for Docksal users. Maybe in a separate CI section?

@shelane
Copy link
Contributor Author

shelane commented Nov 28, 2018

Closed in favor of #3268

@shelane shelane closed this Nov 28, 2018
@shelane shelane deleted the Docksal branch November 28, 2018 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement A feature or feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants