Updating docs, adding video links and next steps. (acquia#614)

dreamfony · Nov 11, 2016 · 1c8c6a7 · 1c8c6a7
1 parent 5f44b74
commit 1c8c6a7
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 62 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,11 @@ See [INSTALL.md](INSTALL.md) to:
 * [Add BLT to an existing project](https://github.com/acquia/blt/blob/8.x/INSTALL.md#adding-blt-to-an-existing-project)
 * [Update BLT](https://github.com/acquia/blt/blob/8.x/INSTALL.md#updating-blt)
 
+## Videos
+
+* [BLT Project Creation](https://www.youtube.com/watch?v=KBwS0fsmXRs)
+* [Deploying to Acquia Cloud](https://www.youtube.com/watch?v=jjnPMvZ2x-c)
+
 ## Philosophy and Purpose
 
 BLT is designed to improve efficiency and collaboration across Drupal projects by providing a common set of tools and standardized structure. It was born out of the need to reduce re-work, project set up time, and developer onboarding time.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,12 +13,13 @@ pages:
   - Home: 'index.md'
   - Overview: 'README.md'
   - Getting started:
-    - System requirements:
-       - Overview:  'INSTALL.md'
+    - Installation:
+       - System requirements:  'INSTALL.md'
        - Running BLT in Ubuntu on Bash on Windows: 'readme/windows-install.md'
        - Alternative LAMP stacks: 'readme/local-development.md'
     - Create a new project: 'readme/creating-new-project.md'
     - Add to existing project: 'readme/adding-to-project.md'
+    - Next steps: 'readme/next-steps.md'
     - Upgrade BLT: 'readme/updating-blt.md'
   - Project documentation:
     - Developer:
@@ -33,7 +34,8 @@ pages:
           - Best practices:
             - Overview: 'readme/best-practices.md'
             - Views: 'readme/views.md'
-          - Workflow: 'readme/dev-workflow.md'
+          - Development Workflow: 'readme/dev-workflow.md'
+          - Configuration Management: 'readme/features-workflow.md'
           - Automated testing: 'readme/testing.md'
     - Technical Architect:
         - Deploying to cloud: 'readme/deploy.md'

diff --git a/readme/adding-to-project.md b/readme/adding-to-project.md
@@ -10,57 +10,3 @@ To add BLT to a pre-existing Drupal project, do the following:
         composer require acquia/blt:^8.3
 
 1. Continue following instructions for step 2 and beyond in [Creating a new project with BLT](../INSTALL.md#creating-a-new-project-with-blt).
-
-# Next steps
-
-Now that your new project works locally, review [BLT documentation by role](https://http://blt.readthedocs.io/) to learn how to perform common project tasks and integrate with third party tools.
-
-Here are tasks that are typically performed at this stage:
-
-* Initialize CI integration. See [Continuous Integration](ci.md).
-
-        blt ci:pipelines:init
-        # OR
-        blt ci:travis:init
-
-* Push to your upstream repo.
-
-        git add -A
-        git commit -m 'My new project is great.'
-        git remote add origin [something]
-        git push origin
-
-* Create and deploy an artifact. See [Deployment workflow](deploy.md).
-
-        # Ensure git.remotes is set in project.yml
-        blt deploy
-
-Other commonly used commands:
-
-        # list targets
-        blt
-
-        # validate code via phpcs, php lint, composer validate, etc.
-        blt validate
-
-        # run phpunit tests
-        blt tests:phpunit
-
-        # ssh into vm & run behat tests
-        drush @[project.machine_name].local ssh
-        blt tests:behat
-
-        # diagnose issues
-        blt doctor
-
-        # download & require a new project
-        composer require drupal/ctools:^8.3.0
-
-        # build a deployment artifact
-        blt deploy:build
-
-        # build artifact and deploy to git.remotes
-        blt deploy
-
-        # update BLT
-        composer update acquia/blt --with-dependencies
diff --git a/readme/next-steps.md b/readme/next-steps.md
@@ -0,0 +1,53 @@
+# Next steps
+
+Now that your new project works locally, review [BLT documentation by role](https://http://blt.readthedocs.io/) to learn how to perform common project tasks and integrate with third party tools.
+
+Here are tasks that are typically performed at this stage:
+
+* Initialize CI integration. See [Continuous Integration](ci.md).
+
+        blt ci:pipelines:init
+        # OR
+        blt ci:travis:init
+
+* Push to your upstream repo.
+
+        git add -A
+        git commit -m 'My new project is great.'
+        git remote add origin [something]
+        git push origin
+
+* Create and deploy an artifact. See [Deployment workflow](deploy.md).
+
+        # Ensure git.remotes is set in project.yml
+        blt deploy
+
+Other commonly used commands:
+
+        # list targets
+        blt
+
+        # validate code via phpcs, php lint, composer validate, etc.
+        blt validate
+
+        # run phpunit tests
+        blt tests:phpunit
+
+        # ssh into vm & run behat tests
+        drush @[project.machine_name].local ssh
+        blt tests:behat
+
+        # diagnose issues
+        blt doctor
+
+        # download & require a new project
+        composer require drupal/ctools:^8.3.0
+
+        # build a deployment artifact
+        blt deploy:build
+
+        # build artifact and deploy to git.remotes
+        blt deploy
+
+        # update BLT
+        composer update acquia/blt --with-dependencies
diff --git a/readme/updating-blt.md b/readme/updating-blt.md
@@ -19,16 +19,20 @@ Rarely, you may need to refresh your local environment via `blt local:setup` to
 By default BLT will modify your project's composer.json to conform with the [upstream composer.json template](https://github.com/acquia/blt/blob/8.x/template/composer.json). If you'd like to prevent a specific package or key in composer.json from being modified, use the `composer-exclude-merge` option:
 
       "blt": {
-            "composer-exclude-merge": {
+          "update": true,
+          "composer-exclude-merge": {
               "require": [
-                "drupal/core"
+                  "drupal/acsf",
+                  "drupal/acquia_connector",
+                  "drupal/memcache",
+                  "drupal/search_api",
+                  "drupal/search_api_solr"
               ],
               "require-dev": "*"
-            }
-         }
+          }
       }
 
-This would prevent the merging of any upstream updates to the composer.json configuration for `drupal/core` in `require` and all packages in `require-dev`.
+This would prevent the merging of any upstream updates to the composer.json configuration for a handful of modules in `require` and all packages in `require-dev`.
 
 ## Updating from a non-Composer-managed (very old) version