Skip to content

Commit 1c8c6a7

Browse files
grasmashdreamfony
authored andcommitted
Updating docs, adding video links and next steps. (acquia#614)
1 parent 5f44b74 commit 1c8c6a7

File tree

5 files changed

+72
-62
lines changed

5 files changed

+72
-62
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ See [INSTALL.md](INSTALL.md) to:
1717
* [Add BLT to an existing project](https://github.com/acquia/blt/blob/8.x/INSTALL.md#adding-blt-to-an-existing-project)
1818
* [Update BLT](https://github.com/acquia/blt/blob/8.x/INSTALL.md#updating-blt)
1919

20+
## Videos
21+
22+
* [BLT Project Creation](https://www.youtube.com/watch?v=KBwS0fsmXRs)
23+
* [Deploying to Acquia Cloud](https://www.youtube.com/watch?v=jjnPMvZ2x-c)
24+
2025
## Philosophy and Purpose
2126

2227
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.

mkdocs.yml

+5-3
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ pages:
1313
- Home: 'index.md'
1414
- Overview: 'README.md'
1515
- Getting started:
16-
- System requirements:
17-
- Overview: 'INSTALL.md'
16+
- Installation:
17+
- System requirements: 'INSTALL.md'
1818
- Running BLT in Ubuntu on Bash on Windows: 'readme/windows-install.md'
1919
- Alternative LAMP stacks: 'readme/local-development.md'
2020
- Create a new project: 'readme/creating-new-project.md'
2121
- Add to existing project: 'readme/adding-to-project.md'
22+
- Next steps: 'readme/next-steps.md'
2223
- Upgrade BLT: 'readme/updating-blt.md'
2324
- Project documentation:
2425
- Developer:
@@ -33,7 +34,8 @@ pages:
3334
- Best practices:
3435
- Overview: 'readme/best-practices.md'
3536
- Views: 'readme/views.md'
36-
- Workflow: 'readme/dev-workflow.md'
37+
- Development Workflow: 'readme/dev-workflow.md'
38+
- Configuration Management: 'readme/features-workflow.md'
3739
- Automated testing: 'readme/testing.md'
3840
- Technical Architect:
3941
- Deploying to cloud: 'readme/deploy.md'

readme/adding-to-project.md

-54
Original file line numberDiff line numberDiff line change
@@ -10,57 +10,3 @@ To add BLT to a pre-existing Drupal project, do the following:
1010
composer require acquia/blt:^8.3
1111

1212
1. Continue following instructions for step 2 and beyond in [Creating a new project with BLT](../INSTALL.md#creating-a-new-project-with-blt).
13-
14-
# Next steps
15-
16-
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.
17-
18-
Here are tasks that are typically performed at this stage:
19-
20-
* Initialize CI integration. See [Continuous Integration](ci.md).
21-
22-
blt ci:pipelines:init
23-
# OR
24-
blt ci:travis:init
25-
26-
* Push to your upstream repo.
27-
28-
git add -A
29-
git commit -m 'My new project is great.'
30-
git remote add origin [something]
31-
git push origin
32-
33-
* Create and deploy an artifact. See [Deployment workflow](deploy.md).
34-
35-
# Ensure git.remotes is set in project.yml
36-
blt deploy
37-
38-
Other commonly used commands:
39-
40-
# list targets
41-
blt
42-
43-
# validate code via phpcs, php lint, composer validate, etc.
44-
blt validate
45-
46-
# run phpunit tests
47-
blt tests:phpunit
48-
49-
# ssh into vm & run behat tests
50-
drush @[project.machine_name].local ssh
51-
blt tests:behat
52-
53-
# diagnose issues
54-
blt doctor
55-
56-
# download & require a new project
57-
composer require drupal/ctools:^8.3.0
58-
59-
# build a deployment artifact
60-
blt deploy:build
61-
62-
# build artifact and deploy to git.remotes
63-
blt deploy
64-
65-
# update BLT
66-
composer update acquia/blt --with-dependencies

readme/next-steps.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Next steps
2+
3+
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.
4+
5+
Here are tasks that are typically performed at this stage:
6+
7+
* Initialize CI integration. See [Continuous Integration](ci.md).
8+
9+
blt ci:pipelines:init
10+
# OR
11+
blt ci:travis:init
12+
13+
* Push to your upstream repo.
14+
15+
git add -A
16+
git commit -m 'My new project is great.'
17+
git remote add origin [something]
18+
git push origin
19+
20+
* Create and deploy an artifact. See [Deployment workflow](deploy.md).
21+
22+
# Ensure git.remotes is set in project.yml
23+
blt deploy
24+
25+
Other commonly used commands:
26+
27+
# list targets
28+
blt
29+
30+
# validate code via phpcs, php lint, composer validate, etc.
31+
blt validate
32+
33+
# run phpunit tests
34+
blt tests:phpunit
35+
36+
# ssh into vm & run behat tests
37+
drush @[project.machine_name].local ssh
38+
blt tests:behat
39+
40+
# diagnose issues
41+
blt doctor
42+
43+
# download & require a new project
44+
composer require drupal/ctools:^8.3.0
45+
46+
# build a deployment artifact
47+
blt deploy:build
48+
49+
# build artifact and deploy to git.remotes
50+
blt deploy
51+
52+
# update BLT
53+
composer update acquia/blt --with-dependencies

readme/updating-blt.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,20 @@ Rarely, you may need to refresh your local environment via `blt local:setup` to
1919
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:
2020

2121
"blt": {
22-
"composer-exclude-merge": {
22+
"update": true,
23+
"composer-exclude-merge": {
2324
"require": [
24-
"drupal/core"
25+
"drupal/acsf",
26+
"drupal/acquia_connector",
27+
"drupal/memcache",
28+
"drupal/search_api",
29+
"drupal/search_api_solr"
2530
],
2631
"require-dev": "*"
27-
}
28-
}
32+
}
2933
}
3034

31-
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`.
35+
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`.
3236

3337
## Updating from a non-Composer-managed (very old) version
3438

0 commit comments

Comments
 (0)