Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit b60b454

Browse files
committed
Fixing indentation.
1 parent 38b4284 commit b60b454

File tree

6 files changed

+57
-72
lines changed

6 files changed

+57
-72
lines changed

INSTALL.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ You should be able to use the following tools on the command line of your native
3232
./vendor/bin/blt install-alias
3333

3434
1. Customize BLT configuration files:
35-
* `project.yml`
36-
* `docroot/sites/default/settings/local.settings.php`
37-
* Add your local DB credentials to `$databases`
35+
* `project.yml`
36+
* `docroot/sites/default/settings/local.settings.php`
37+
* Add your local DB credentials to `$databases`
3838
1. Replace tokens in new BLT-generated files with your custom values in project.yml:
3939

4040

4141
blt configure
4242

4343
1. (optional) Modify project files. Important files that you may want to modify include:
44-
* composer.json. Note that Drupal core, contrib, and third party dependencies are all managed here.
45-
* Project’s root README.md.
46-
* Other project documentation in the readme directory.
44+
* composer.json. Note that Drupal core, contrib, and third party dependencies are all managed here.
45+
* Project’s root README.md.
46+
* Other project documentation in the readme directory.
4747
1. (optional) Follow instructions for <a href="#install">installing Drupal locally</a>.
4848

4949
## Adding BLT to an existing project
@@ -59,9 +59,9 @@ To add BLT to a pre-existing Drupal project, do the following:
5959
./vendor/acquia/blt/blt.sh init
6060

6161
1. (optional) Modify project files. Important files that you may want to modify include:
62-
* composer.json. Note that Drupal core, contrib, and third party dependencies are all managed here.
63-
* Project’s root README.md.
64-
* Other project documentation in the readme directory.
62+
* composer.json. Note that Drupal core, contrib, and third party dependencies are all managed here.
63+
* Project’s root README.md.
64+
* Other project documentation in the readme directory.
6565
1. (optional) Follow instructions for <a href="#install">installing Drupal locally</a>.
6666

6767
## Updating BLT
@@ -109,9 +109,9 @@ Before building your project dependencies and installing Drupal, you must have a
109109

110110
Please see [Local Development](template/readme/local-development.md) for more information on setting up your \*AMP stack:
111111

112-
* [Acquia Dev Desktop](template/readme/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects)
113-
* [Drupal VM](template/readme/local-development.md#using-drupal-vm-for-blt-generated-projects)
114-
* [Other](https://github.com/acquia/blt/blob/8.x/template/readme/local-development.md#alternative-local-development-environments)
112+
* [Acquia Dev Desktop](template/readme/local-development.md#using-acquia-dev-desktop-for-blt-generated-projects)
113+
* [Drupal VM](template/readme/local-development.md#using-drupal-vm-for-blt-generated-projects)
114+
* [Other](https://github.com/acquia/blt/blob/8.x/template/readme/local-development.md#alternative-local-development-environments)
115115

116116
When you have completed setting up your local \*AMP stack, double check that the following pieces of information are still correct:
117117

template/readme/best-practices.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _This document is a work in progress._ Unlinked items are planned topics, feel f
88

99
All work must conform to established best practices and coding standards. Code quality is ensured in a variety of ways:
1010

11-
* All code must conform to [Drupal Coding Standards](https://www.drupal.org/coding-standards). This is enforced via [local git hooks](../scripts/git-hooks/README.md) and [code checks](../build/ performed during continuous integration.
11+
* All code must conform to [Drupal Coding Standards](https://www.drupal.org/coding-standards). This is enforced via [local git hooks](../scripts/git-hooks/README.md) and code checks performed during continuous integration.
1212
* All front end code must follow Drupal Theming Best Practices.
1313
* All code must be reviewed by a peer or established integrator before being merged into the master branch.
1414
* All new features must covered by an automated test that mirrors the ticket acceptance criteria.
@@ -91,13 +91,14 @@ Please see [views.md](views.md).
9191

9292
## Logging
9393

94-
* Any configuration changes from custom modules should be logged to watchdog (also [Acquia Library recommendations|https://docs.acquia.com/articles/how-audit-authenticated-user-actions-better-risk-management])
94+
* Any configuration changes from custom modules should be logged to watchdog (also [Acquia Library recommendations](https://docs.acquia.com/articles/how-audit-authenticated-user-actions-better-risk-management)
9595
* Any destructive actions **must** be logged
9696

9797

9898
## Building content types
9999

100100
@todo Document:
101+
101102
* Appropriate time to use fields
102103
* Audit for overly complex content types
103104
* Reason: All fields loaded for each node load

template/readme/ci.md

+16-23
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,15 @@ Automated testing of live content is easy to set up with two simple steps:
2121

2222
1. Add the hostname of your staging server to .travis.yml:
2323

24-
```
25-
ssh_known_hosts:
26-
- staging-12345.prod.hosting.acquia.com
27-
```
24+
ssh_known_hosts:
25+
- staging-12345.prod.hosting.acquia.com
26+
2827
2. Override the default `ci:build:validate:test` target by adding the following to `build/custom/phing/build.xml`:
2928

30-
```
31-
<!-- Override the core ci:build:validate:test target to include a local refresh-->
32-
<target name="ci:build:validate:test" description="Builds, validates, tests, and deploys an artifact."
33-
depends="validate:all, ci:setup, tests:security-updates, tests:phpunit, local:sync, local:update, tests:behat" />
34-
```
29+
<!-- Override the core ci:build:validate:test target to include a local refresh-->
30+
<target name="ci:build:validate:test" description="Builds, validates, tests, and deploys an artifact."
31+
depends="validate:all, ci:setup, tests:security-updates, tests:phpunit, local:sync, local:update, tests:behat" />
32+
3533

3634
### Setting Up Travis CI for automated deployments
3735

@@ -46,31 +44,26 @@ To set up this workflow, you must configure Acquia Cloud, GitHub, and Travis CI
4644

4745
1. Generate an SSH key locally. E.g.,
4846

49-
```
50-
cd ~/.ssh
51-
ssh-keygen -t rsa -b 4096
52-
```
47+
cd ~/.ssh
48+
ssh-keygen -t rsa -b 4096
5349

5450
Do not use a passphrase!
51+
5552
1. Create a new Acquia Cloud account to be used exclusively as a container for the SSH keys that will grant Travis push access to Acquia Cloud. This can be done by inviting a new team member on the "Teams" tab in Acquia Cloud. You can use an email address like `<email>[email protected]`. The team member must have SSH push access.
5653
1. Login the your new Acquia Cloud account and add the public SSH key from the key pair that was generated in step 1 by visiting `https://accounts.acquia.com/account/[uid]/security`.
5754
1. Add the same public SSH key to the "Deployment Keys" section on your project's GitHub settings page, located at `https://github.com/acquia-pso/[project-name]/settings/keys`.
5855
1. Add the _private SSH key_ to your project's Travis CI settings located at `https://magnum.travis-ci.com/acquia-pso/[project-name]/settings`.
5956
1. Uncomment the example deployment steps in your .travis.yml file and customize them to deploy your desired branch.
6057
1. Add your cloud git repository to the remotes section of your project.yml file:
61-
62-
```
63-
remotes:
64-
- [email protected]:example.git`
65-
```
58+
59+
remotes:
60+
- [email protected]:example.git`
6661

6762
1. Add your cloud git repository's server host name to `ssh_known_hosts` in your .travis.yml file.
6863

69-
```
70-
addons:
71-
ssh_known_hosts:
72-
- svn-14671.prod.hosting.acquia.com
73-
```
64+
addons:
65+
ssh_known_hosts:
66+
- svn-14671.prod.hosting.acquia.com
7467

7568
1. Commits or merges to the develop branch on GitHub should now trigger a fully built artifact to be deployed to your specified remotes.
7669

template/readme/local-development.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -66,17 +66,14 @@ In order to use a custom version of Drush (required by BLT) with Dev Desktop, yo
6666

6767
1. Add the following lines to `~/.bash_profile`:
6868

69-
```
70-
export PATH="/Applications/DevDesktop/mysql/bin:$PATH"
71-
export DEVDESKTOP_DRUPAL_SETTINGS_DIR="~/.acquia/DevDesktop/DrupalSettings"
72-
73-
```
69+
export PATH="/Applications/DevDesktop/mysql/bin:$PATH"
70+
export DEVDESKTOP_DRUPAL_SETTINGS_DIR="~/.acquia/DevDesktop/DrupalSettings"
71+
7472
1. Ensure that Dev Desktop's PHP binary is being used on the CLI. You can check this via `which php`.
7573
1. Enable the usage of environmental variables by adding the following line to `php.ini`, which you can locate with `php --ini`:
7674

77-
```
78-
variables_order = "EGPCS"
79-
```
75+
variables_order = "EGPCS"
76+
8077
1. Restart your terminal session after making the aforementioned changes.
8178

8279
## Alternative local development environments
@@ -85,10 +82,10 @@ For reasons, some teams may prefer to use a different development environment. D
8582

8683
It is up to each team to choose how to handle local development, but some of the main things that help a project's velocity with regard to local development include:
8784

88-
- Uniformity and the same configuration across all developer environments.
89-
- Ease of initial environment configuration (if it takes more than an hour to get a new developer running your project locally, you're doing it wrong).
90-
- Ability to emulate all aspects of the production environment with minimal hassle (e.g. Varnish, Memcached, Solr, Elasticsearch, different PHP versions, etc.).
91-
- Helpful built-in developer tools (e.g. XHProf, Xdebug, Adminer, PimpMyLog).
92-
- Ease of use across Windows, Mac, or Linux workstations.
85+
* Uniformity and the same configuration across all developer environments.
86+
* Ease of initial environment configuration (if it takes more than an hour to get a new developer running your project locally, you're doing it wrong).
87+
* Ability to emulate all aspects of the production environment with minimal hassle (e.g. Varnish, Memcached, Solr, Elasticsearch, different PHP versions, etc.).
88+
* Helpful built-in developer tools (e.g. XHProf, Xdebug, Adminer, PimpMyLog).
89+
* Ease of use across Windows, Mac, or Linux workstations.
9390

9491
If you choose to use a different solution than recommended here, please make sure it fits all the needs of your team and project, and will not be a hindrance to project development velocity!

template/readme/onboarding.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,13 @@ If you need to make requests via a proxy server, please [configure git to use a
4444
1. [Fork](https://help.github.com/articles/fork-a-repo) the primary GitHub repository
4545
1. Clone your fork to your local machine:
4646

47-
```
48-
git clone [email protected]:username/project-repo.git -b develop
49-
git remote add upstream [email protected]:acquia-pso/project-repo.git
50-
```
47+
git clone [email protected]:username/project-repo.git -b develop
48+
git remote add upstream [email protected]:acquia-pso/project-repo.git
5149

5250
1. Checkout the `develop` branch. `git checkout develop`
5351
1. Run `composer install` (you must already have Composer installed).
54-
1. Run `blt setup:drupal:settings` This will generate
55-
`docroot/sites/default/settings/local.settings.php` and
56-
`docroot/sites/default/local.drushrc.php`. Update these with your local
57-
database credentials and your local site URL.
58-
1. Run `blt local:setup`. This will build all project dependencies and install
59-
drupal.
52+
1. Run `blt setup:drupal:settings` This will generate `docroot/sites/default/settings/local.settings.php` and `docroot/sites/default/local.drushrc.php`. Update these with your local database credentials and your local site URL.
53+
1. Run `blt local:setup`. This will build all project dependencies and install drupal.
6054
1. Create and edit your local drush alias file. Copy `drush/site-aliases/example.local.aliases.drushrc.php` to `drush/site-aliases/local.aliases.drushrc.php`. Edit the new alias file with your local path.
6155

6256
After this initial setup, you should only need to run `blt setup:build` when composer.json is updated, and `blt local:drupal:install` when you need to reinstall the site.

template/readme/views.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@
55
The following are guidelines for building new views.
66

77
* _Caching_
8-
* For all public facing views, always use some form of caching. A non time-based cache is preferable because it often permits the longest cache lifetimes, and invalidates caches only when necessary. Possible options are:
9-
* [Views content cache](https://www.drupal.org/project/views_content_cache)
10-
* [Views argument cache](https://www.drupal.org/project/views_arg_cache)
11-
* Time based
8+
* For all public facing views, always use some form of caching. A non time-based cache is preferable because it often permits the longest cache lifetimes, and invalidates caches only when necessary. Possible options are:
9+
* [Views content cache](https://www.drupal.org/project/views_content_cache)
10+
* [Views argument cache](https://www.drupal.org/project/views_arg_cache)
11+
* Time based
1212
* _Pagination_
13-
* Always specify either a fixed number of results or a pager. Never display all results.
14-
* Whenever possible, use Views lite pager rather than a full pager.
15-
* Note that this is unfortunately mutually exclusive with caching due to bugs in Views Lite Pager. @see https://www.drupal.org/node/2285591.
13+
* Always specify either a fixed number of results or a pager. Never display all results.
14+
* Whenever possible, use Views lite pager rather than a full pager.
15+
* Note that this is unfortunately mutually exclusive with caching due to bugs in Views Lite Pager. @see https://www.drupal.org/node/2285591.
1616
* _Advanced_
17-
* Always add a semantically descriptive machine name to views displays. E.g., use `press_releases_all` rather than `page_1`. This makes all PHP, CSS, and JS related to the view display more readable.
17+
* Always add a semantically descriptive machine name to views displays. E.g., use `press_releases_all` rather than `page_1`. This makes all PHP, CSS, and JS related to the view display more readable.
1818
* _Relationships_
19-
* Whenever possible, use "require this relationship" for all views relationships. This causes views to perform an inner join rather than a left join, and is almost always faster.
20-
* Never use the `Taxonomy Terms on Node` relationship or filter. Instead, use a relationship or filter for the specific taxonomy reference field. This has a tremendous performance impact.
19+
* Whenever possible, use "require this relationship" for all views relationships. This causes views to perform an inner join rather than a left join, and is almost always faster.
20+
* Never use the `Taxonomy Terms on Node` relationship or filter. Instead, use a relationship or filter for the specific taxonomy reference field. This has a tremendous performance impact.
2121
* _Filters_
22-
* For all exposed filters, manually set the fitler identifier to something end-user friendly. This should not contain drupalisms. E.g., use `type` rather than `field_type`.
22+
* For all exposed filters, manually set the fitler identifier to something end-user friendly. This should not contain drupalisms. E.g., use `type` rather than `field_type`.
2323
* _No Results Behavior_
24-
* Always add "No Results behavior" of some type. This is typically text informing that user that no results were found.
24+
* Always add "No Results behavior" of some type. This is typically text informing that user that no results were found.
2525

2626
@todos:
2727

0 commit comments

Comments
 (0)