docs: update breaking changes and add migration schematics to v8 migr…

…ation guide (#1776)
ngrx · Apr 23, 2019 · be106c9 · be106c9
1 parent 4c850b5
commit be106c9
Showing 1 changed file with 27 additions and 13 deletions.
diff --git a/projects/ngrx.io/content/guide/migration/v8.md b/projects/ngrx.io/content/guide/migration/v8.md
@@ -2,7 +2,7 @@
 
 ## Angular CLI update
 
-NgRx supports using the Angular CLI `ng update` command to update your dependencies.
+NgRx supports using the Angular CLI `ng update` command to update your dependencies. Migration schematics are run to make the upgrade smoother. These schematics will fix breaking changes.
 
 To update your packages to the latest released version, run the command below.
 
@@ -18,16 +18,24 @@ V8 has the minimum version requirements:
 - TypeScript version 3.3.x
 - RxJS version 6.x
 
-## @ngrx/store
+## Breaking changes
 
-### `META_REDUCERS` token
+### @ngrx/store
+
+#### `META_REDUCERS` token
+
+<div class="alert is-helpful">
+
+A migration is provided to rename the `META_REDUCERS` token to `USER_PROVIDED_META_REDUCERS`
+
+</div>
 
 The `META_REDUCERS` token has been renamed to `USER_PROVIDED_META_REDUCERS`.
 
 The `META_REDUCERS` token has become a multi token and can be used by
 library authors.
 
-### Selectors with only a projector function aren't valid anymore
+#### Selectors with only a projector function aren't valid anymore
 
 This change will make the usage of selectors more consistent.
 
@@ -48,11 +56,17 @@ const getTodosById = createSelector(
 );
 ```
 
-## @ngrx/router-store
+### @ngrx/router-store
+
+#### Required usage of `forRoot`
+
+<div class="alert is-helpful">
+
+A migration is provided and will append `forRoot` to `StoreRouterConnectingModule`
 
-### Required usage of forRoot
+</div>
 
-Usage of forRoot is now required for StoreRouterConnectingModule
+Usage of `forRoot` is now required for `StoreRouterConnectingModule`
 
 BEFORE:
 
@@ -76,15 +90,15 @@ AFTER:
 export class AppModule {}
 ```
 
-## @ngrx/entity
+### @ngrx/entity
 
-### add undefined to Dictionary's index signature
+#### add undefined to Dictionary's index signature
 
-Dictionary could be producing `undefined` but previous typings were not explicit about it.
+`Dictionary` and `DictionaryNum` could be producing `undefined` but previous typings were not explicit about it.
 
-## @ngrx/store-devtools
+### @ngrx/store-devtools
 
-### `actionsWhitelist` is renamed to `actionsSafelist`
+#### `actionsWhitelist` is renamed to `actionsSafelist`
 
 BEFORE:
 
@@ -102,7 +116,7 @@ StoreDevtoolsModule.instrument({
 })
 ```
 
-### `actionsBlacklist` is renamed to `actionsBlocklist`
+#### `actionsBlacklist` is renamed to `actionsBlocklist`
 
 BEFORE: