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

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

Merged
merged 1 commit into from
Nov 1, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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'
Expand Down
54 changes: 0 additions & 54 deletions readme/adding-to-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
53 changes: 53 additions & 0 deletions readme/next-steps.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 9 additions & 5 deletions readme/updating-blt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down