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

ISSUE-33 Drupal Quickstart file name and syntax update. #34

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
42 changes: 22 additions & 20 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Particle provides a Drupal 8 theme, the starting steps are slightly different:
1. [Download the latest release](https://github.com/phase2/particle/releases)
1. Extract to `themes/` at the root of your Drupal 8 install. (i.e. this readme should be at `{drupal-root}/themes/particle/README.md`)
1. Download and install the [Component Libraries module](https://www.drupal.org/project/components):

```
drush dl components
drush en components -y
```

or

```
drupal module:install components
```
Expand All @@ -43,32 +43,34 @@ Particle provides a Drupal 8 theme, the starting steps are slightly different:

This will compile all assets and provide all namespaced Twig paths to the Drupal theme. Make sure to choose this theme in Drupal Appearance settings and `drush cr ` or `drupal cr all` to clear cache.

For rapid, development-mode recompile and Drupal cache clear, edit `webpack.drupal.dev.js`, find the `onBuildEnd` plugin and edit it from:
For rapid, development-mode recompile and Drupal cache clear, edit `apps/drupal-default/webpack.config.js`, find the `RunScriptAfterEmit` plugin and edit it from:

```js
// ORIGINAL
plugins: [
new WebpackShellPlugin({
onBuildEnd: [
// CHANGE THE FOLLOWING LINE
'echo \nWebpack drupal dev build complete! Edit apps/drupal/webpack.drupal.dev.js to replace this line with `drupal cr all` now.',
],
dev: false, // Runs on EVERY rebuild
}),
],
plugins: [
new RunScriptAfterEmit({
exec: [
// prettier-ignore
`echo \n🚀 Webpack Drupal ${NODE_ENV} build complete! Edit
apps/drupal-default/webpack.config.js to replace this line with
anything you'd like run after rebuilding assets, e.g.
'drupal cr all'. 🚀\n`,
],
}),
],
```

to:

```js
// UPDATED
plugins: [
new WebpackShellPlugin({
onBuildEnd: [
'drupal cr all',
],
dev: false, // Runs on EVERY rebuild
}),
plugins: [
new RunScriptAfterEmit({
exec: [
'drupal cr all',
],
}),
],
],
```

Expand Down