Skip to content

Commit

Permalink
Adding next steps docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
grasmash committed Oct 7, 2016
1 parent e56c078 commit 1e8c6f6
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 38 deletions.
56 changes: 53 additions & 3 deletions readme/adding-to-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,58 @@ 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).
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
# Next steps

Review [BLT documentation by role](https://http://blt.readthedocs.io/) to learn how to perform common project tasks and integrate with third party tools.
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
37 changes: 2 additions & 35 deletions readme/creating-new-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,10 @@
composer blt-alias

1. Customize `project.yml`.
1. Create & boot the VM, install Drupal.
1. Create & boot the VM, install Drupal.

blt vm
blt local:setup

1. Login to Drupal `drush @[project.machine_name].local uli`, where [project.machine_name] is the value that you set in project.yml.

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

A few popular 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
1. See [Next steps](next-steps.md).

0 comments on commit 1e8c6f6

Please sign in to comment.