-
Notifications
You must be signed in to change notification settings - Fork 395
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
Docksal documentation #3268
Docksal documentation #3268
Conversation
Fixes bullet formatting and sets list in alphabetical order.
@shelane @lpeabody think the new docs help there. however, i'm still confused, why not just use blt sync if you want to sync and blt setup if you want a clean install? significantly simplifies the command structure. am i overlooking something that |
@mikemadison13 In 99.9999% of cases there is probably going to be no functional difference between the two of those individual commands. It might be a philosophical question: manually running commands to do different things, or, running a smaller set of commands whose behavior is influenced by configuration. BLT has an extremely strong configuration model, and so it benefits us to leverage that and integrate it with Docksal's robust custom command architecture. I'll provide some use cases: Developing and launching a new site
You make this change once, it is shared with everyone, and everyone continues to run the same, single command, Docksal-enabled CI environment Finalizing thoughts If we're going to be providing documentation on how to best integrate BLT with Docksal, we should be providing some level of philosophical guidance around normalizing your project's command architecture since that is one of the biggest benefits of using Docksal. EDIT: Just to be clear, I am not saying "this is the way you need to use Docksal with BLT". It is very much open to interpretation and experimentation, that's what makes our jobs so fun :) This is my take on how Docksal and BLT can be integrated in a symbiotic way. |
I have included the text about the use with a CI environment. |
By default, BLT is set to work with Drupal VM. It is easy to set up to use with Docksal, but | ||
you will have to install the Docksal `blt` addon command and make some configuration changes. | ||
|
||
## Setting Your Project to Use Docksal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe substitute in fin config generate --stack=acquia
here. This will set up the project with memcache and solr as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, makes sense given what we're integrating with...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added with the preferred fin config set DOCKSAL_STACK=acquia
.
* Fixes #3265 to expand alias documentation. (#3399) * Fixes #3401 for 9.2.x to update devel. * Moved pipelines-deploy from build event to post-deploy event (#3374) * Docksal documentation (#3268) * Add links to docsal and ddev pages. * Updates ignore-existing to include .editorconfig. (#3300) Fixes #3169 -------- Changes proposed: --------- (What are you proposing we change?) - adds the .editorconfig file to the ignore list for blt updates * Updating BLT's docs to remove nvm and point to Cog's documentation for theme installation. (#3313) * Fix broken link to Cloud Hooks docs. (#3331) * Added steps to install nfs-utils and enable access via firewalld; without it DrupalVm gets stuck at mounting NFS (#3376) * Updates release and readme docs. (#3382) * Updates Travis and Pipelines to PHP 7.1 by default. * Adds FAQ for drush 8/9 permission denied issue. (#3264) * Add setup instructions for PHPStorm + PHPUnit (#1787) (#3198) * Update INSTALL.md (#3273) * Speed up deploys with shallow fetching (#3271) Before: ``` real 4m11.340s user 1m3.430s sys 1m23.638s ``` After: ``` real 3m14.776s user 0m47.570s sys 1m6.415s ``` * Fixes #3217 to provide acsf-init-verify as part of git hooks and blt validate. (#3218) * Updating Drupal VM config versions. (#3328) * Fixes #3345 to run db updates even when config strategy is none. (#3363) * Fixes #3362 to better identify why the site URI is not found. (#3369) * Test tests:acsf:validate (#3392) * Test tests:acsf:validate * Delete README.md Remove cloud hook readme. * Update AcsfHooksTest.php * Update AcsfHooksTest.php * Update DeployTest.php * Fixes #3383 to backport Pipelines update to 9.2.x. * Increase wait timeout. (#3163) * Fixes #3122 to remove misleading jmeter example. (#3230) * Fixes #3223 to update git docs. (#3226)
Changes proposed:
(What are you proposing we change?)
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. This PR is for 10.0.x, but should be committed to 9.2.x as well.
@mikemadison13 This addresses Les's suggestion as well with an additional comment on setup strategy. BLT should really have more extensive documentation on that as it specific to BLT and not an environment. I rerolled this to 10.0.x since the DDEV docs were included and there would have been a merge conflict with the change to the page with the list of environment tips.