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

Commit c86a02c

Browse files
committed
Removing named anchors.
1 parent 42234e4 commit c86a02c

7 files changed

+30
-55
lines changed

template/readme/best-practices.md

+8-17
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,7 @@
44

55
_This document is a work in progress._ Unlinked items are planned topics, feel free to contribute.
66

7-
* [Standards](#standards)
8-
* [Exporting configuration](#exporting-config)
9-
* [Configuration updates](#config-updates)
10-
* [Caching strategies](#caching)
11-
* [Patching](#patching)
12-
* [Building Views](#views)
13-
* [Logging](#logging)
14-
* [Building content types](#content-types)
15-
16-
## <a name="standards"></a>Standards
7+
## Standards
178

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

@@ -24,7 +15,7 @@ All work must conform to established best practices and coding standards. Code q
2415

2516
Please peruse the [examples](examples) directory for examples of various coding best practices.
2617

27-
## <a name="exporting-config"></a>Exporting configuration
18+
## Exporting configuration
2819

2920
All site functionality should be represented in version-controlled code. This includes all configuration. Drupal configuration is typically exported via [Features](https://www.drupal.org/project/features).
3021

@@ -53,7 +44,7 @@ Common mistakes:
5344
* Each feature has too many dependencies, so no one feature can be used in isolation, or a single feature becomes impossible to disable. E.g., the "Workflow" feature depends on the "Press Room" feature because it requires field_body which is provided by "Press Room."
5445
* Features are too granular. E.g., there is a separate feature for each role, a feature contains only a single view, etc.
5546

56-
## <a name="config-updates"></a>Configuration updates
47+
## Configuration updates
5748

5849
* If a change is happening, that change needs to be documented in code, preferably an update hook. E.g.,
5950
* Reverting features and feature components `features_revert_module()`
@@ -62,7 +53,7 @@ Common mistakes:
6253
* Updates needs to be actively monitored. This should be done using NewRelic, SumoLogic, Logstreaming, and/or other monitoring tools.
6354
* Updates need to be intentional. E.g., don't use cloud hooks or cron jobs to automatically execute updates or clear caches.
6455

65-
## <a name="caching"></a>Caching
56+
## Caching
6657

6758
Without caching, Drupal is slow. As a general rule of thumb, _try to cache everything that you can_ and _try to invalidate that cache only when it is likely to be stale_.
6859

@@ -89,22 +80,22 @@ Specifically, ensure that you are properly caching data at every level possible,
8980

9081
See the [Drupal 8 Cache API](https://www.drupal.org/developing/api/8/cache) documentation for information in implementing your caching strategy.
9182

92-
## <a name="patching"></a>Patching
83+
## Patching
9384

9485
All modifications to contributed code should be performed via a patch. For detailed information on how to patch projects, please see [../patches/README.md]
9586
(../patches/README.md)
9687

97-
## <a name="views"></a>Views
88+
## Views
9889

9990
Please see [views.md](views.md).
10091

101-
## <a name="logging"></a>Logging
92+
## Logging
10293

10394
* 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])
10495
* Any destructive actions **must** be logged
10596

10697

107-
## <a name="content-types"></a>Building content types
98+
## Building content types
10899

109100
@todo Document:
110101
* Appropriate time to use fields

template/readme/ci.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## <a name="ci"></a> Continuous Integration
1+
## Continuous Integration
22

33
Integration with Travis CI is included, although Phing tasks can be used with any CI tool. The default Travis CI build process is as follows:
44

template/readme/deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This task is analogous to `setup:build` but with a few critical differences:
3333

3434
After the artifact is created, you can inspect it or even run it as a website locally. You may also manually commit and push it to ACE.
3535

36-
## <a name="build-artifact"></a>Create and deploy the build artifact
36+
## Create and deploy the build artifact
3737

3838
To both create and deploy the build artifact in a single command, run the following command
3939

template/readme/local-development.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Acquia currently recommends the use of either:
44

55
* [Drupal VM](#drupal-vm): An isolated virtual machine, built with Vagrant and Ansible.
6-
* [Acquia Dev Desktop](#dd): A turn-key LAMP stack tailored specifically for Acquia-hosted Drupal sites.
6+
* [Acquia Dev Desktop](#acquia-dev-desktop): A turn-key LAMP stack tailored specifically for Acquia-hosted Drupal sites.
77

88
No matter what local environment you choose to use, the following guidelines should be followed:
99

@@ -23,7 +23,7 @@ If you must use Windows, we recommend that:
2323
* [cmder](http://cmder.net/)
2424
* [cygwin](https://www.cygwin.com/)
2525

26-
## <a name="drupal-vm"></a>Using Drupal VM for BLT-generated projects
26+
## Using Drupal VM for BLT-generated projects
2727

2828
_BLT support for Drupal VM is experimental. Not all BLT features currently work with Drupal VM. Additionally, Drupal VM integration with BLT cannot be tested via Travis CI, and is prone to regressions._
2929

@@ -54,7 +54,7 @@ To execute Behat tests using the 'drupal' driver on a Drupal VM environment, you
5454

5555
You may choose to write only behat tests that utilize the Drupal Extension's "drupal" driver. Doing this will allow you to run `blt tests:behat` from the host machine without modificaitons to the Behat local.yml configuration.
5656

57-
## <a name="dd"></a>Using Acquia Dev Desktop for BLT-generated projects
57+
## Using Acquia Dev Desktop for BLT-generated projects
5858

5959
### Project creation and installation changes
6060

template/readme/project-tasks.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,7 @@
22

33
“how do I _____ on my local machine?”
44

5-
* [(re)Install Drupal](#install-drupal)
6-
* [Update dependencies (module, theme, core, etc.)](#update-dependency)
7-
* [Patch a project](#patch)
8-
* [Deploy to cloud](#deploy)
9-
* [Run tests & code validation](#tests)
10-
* [Build frontend assets](#frontend)
11-
12-
## <a name="install-drupal"></a>(re)Install Drupal
5+
## (re)Install Drupal
136

147
Pre-requisites to installation:
158

@@ -19,7 +12,7 @@ Pre-requisites to installation:
1912

2013
To re-install Drupal, execute: `blt setup:drupal:install`. Note that this will drop the existing database tables and install Drupal from scratch!
2114

22-
## <a name="update-dependency"></a>Update dependencies (core, profile, module, theme, libraries)
15+
## Update dependencies (core, profile, module, theme, libraries)
2316

2417
Composer should be used to manage Drupal core, all contributed dependencies, and most third party libraries. The primary exception to this is front end libraries that may be managed via a front-end specific dependency manager, such as [Bower](http://bower.io/) or [NPM](https://www.npmjs.com/).
2518

@@ -50,15 +43,15 @@ To update drupal core:
5043
4. Use git to review changes to committed files. E.g., changes to .htaccess, robots.txt, etc.
5144
5. Add and commit desired changes.
5245

53-
## <a name="patch"></a>Patch a project
46+
## Patch a project
5447

5548
Please see [patches/README.md](../patches/README.md) for information on patch naming, patch application, and patch contribution guidance.
5649

57-
## <a name="deploy"></a>Deploy to cloud
50+
## Deploy to cloud
5851

5952
Please see [Deploy](deploy.md) for a detailed description of how to deploy to Acquia Cloud.
6053

61-
## <a name="tests"></a>Run tests & code validation
54+
## Run tests & code validation
6255

6356
Please see [tests/README.md](../tests/README.md) for information on running tests.
6457

@@ -68,7 +61,7 @@ To execute PHP codesniffer and PHP lint against the project codebase, run:
6861
blt validate:all
6962
```
7063

71-
## <a name="frontend"></a>Build front end assets
64+
## Build front end assets
7265

7366
Ideally, you will be using a theme that uses SASS/SCSS, a styleguide, and other tools that require compilation. Like dependencies, the compiled assets should not be directly committed to the project repository. Instead, they should be built during the creation of a production-ready build artifact.
7467

@@ -98,7 +91,7 @@ This command will be executed when dependencies are built in a local or CI envir
9891
blt frontend:build
9992
```
10093

101-
## <a name="local-tasks"></a>Updating your local environment
94+
## Updating your local environment
10295

10396
The project is configured to update the local environment with a local drush alias and a remote alias as defined in `project.yml` or `project.local.yml`. Given that these aliases match, those in `drush/site-aliases/`, you can update the site with BLT. Please see [drush/README.md](../drush/README.md) for details on how to create these aliases.
10497

template/readme/release-process.md

+7-16
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,24 @@
1-
# Release Process
1+
# Release Processs
22

3-
This document is a work in progress.
4-
5-
* [Generating a build artifact](#build-artifact)
6-
* [Branching strategies](#branching)
7-
* [Tagging](#tagging)
8-
* [Release Notes](#release-notes)
9-
* [Deploying tag and executing updates](#deploy-tag)
10-
* [Notifications](#notifications) (slack, hipchat, etc)
11-
12-
## <a name="branching"></a>Branching strategies
3+
## Branching strategies
134

145
@todo Document this!
156

16-
## <a name="build-artifact"></a>Generating a build artifact
7+
## Generating a build artifact
178

189
See [Create and deploy the build artifact](deploy.md#build-artifact) in [deploy.md](deploy.md).
1910

20-
## <a name="tagging"></a>Tagging
11+
## Tagging
2112

2213
@todo Document this!
2314

24-
## <a name="release-notes"></a>Release notes
15+
## Release notes
2516

2617
Each release should be accompanied by a set of release notes, which can be easily generated using the [Release Notes Script](../scripts/release-notes/README.md).
2718

2819
This script will automatically aggregate all of the descriptions from Pull Requests since a specified date. The generated tet aggregate can then be copied and pasted into release notes on GitHub.
2920

30-
## <a name="deploy-tag"></a>Deploying tag and executing updates
21+
## Deploying tag and executing updates
3122

3223
Deploying Drupal across environments can be daunting, but if due diligence has been taken with configuration management, the process of deployment is actually quite simple.
3324

@@ -48,7 +39,7 @@ A few things that you should (almost) never do on production:
4839

4940
There might be some extra steps depending on the infrastructure and the extent of site changes. For example, a major application change might require a flush of other caches in the system such as Varnish or Memcached.
5041

51-
# <a name="notifications">Notifications
42+
# Notifications
5243

5344
You can configure various tools to provide notifications of deployment related events. For instance:
5445

template/tests/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This directory contains all projects tests, grouped by testing technology. For a
6565
├── jmeter - contains all jMeter tests
6666
└── phpunit - contains all PHP Unit tests
6767

68-
## <a name="executing-tests"></a>Executing tests
68+
## Executing tests
6969

7070
Before attempting to execute any tests, verify that composer dependencies are built by running `composer install` in the project root.
7171

@@ -85,7 +85,7 @@ For more information on the commands, run:
8585
* `./vendor/bin/phpunit --help`
8686
* `./vendor/bin/behat --help`
8787

88-
## <a name="behat"></a>Behat
88+
## Behat
8989

9090
The high-level purpose BDD is to create a strong connection between business requirements and the actual tests. Behat tests should mirror ticket acceptance criteria as closely as possible.
9191

@@ -144,7 +144,7 @@ PHP based BDD library. Best practices for tests writing apply to both
144144
* [The training wheels came off](http://aslakhellesoy.com/post/11055981222/the-training-wheels-came-off)
145145

146146

147-
## <a name="phpunit"></a>PHPUnit
147+
## PHPUnit
148148

149149
Project level, functional PHPUnit tests are included in `tests/phpunit`. Any PHPUnit tests that affect specific modules or application level features should be placed in the same directory as that module, not in this directory.
150150

0 commit comments

Comments
 (0)