Docs: Add instructions for using ng add #1770

santoshyadavdev · 2019-04-17T19:41:29Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[X] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Closes #1739

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[X] No

Other information

ngrxbot · 2019-04-17T19:49:50Z

Preview docs changes for 40f597a at https://previews.ngrx.io/pr1770-40f597a/

ngrxbot · 2019-04-18T03:51:54Z

Preview docs changes for 08c2463 at https://previews.ngrx.io/pr1770-08c2463/

timdeschryver · 2019-04-19T20:16:26Z

projects/ngrx.io/content/guide/schematics/install.md

@@ -15,3 +15,29 @@ For more information on using `yarn` check out the docs <a href="https://yarnpkg
 ```sh
 yarn add @ngrx/schematics --dev
 ```
+
+## Make @ngrx/scematics as default for app


Suggested change

## Make @ngrx/scematics as default for app

## Installing with `ng add`

timdeschryver · 2019-04-19T20:21:27Z

projects/ngrx.io/content/guide/schematics/install.md

+
+## Make @ngrx/scematics as default for app
+
+You can also make @ngrx/schematics as default for your app. Run below command inside an angular application from the root.


Suggested change

You can also make @ngrx/schematics as default for your app. Run below command inside an angular application from the root.

You can also make `@ngrx/schematics` the default collection for your application. Run the below command inside your Angular application from within the root.

timdeschryver · 2019-04-19T20:25:40Z

projects/ngrx.io/content/guide/schematics/install.md

+
+`Do you want to use @ngrx/schematics as the default collection?(y/n)`
+
+Once you select `yes` you can notice below line added to `package.json`.


Suggested change

Once you select `yes` you can notice below line added to `package.json`.

Once you select `yes` it will change the `defaultCollection` inside `angular.json`.

timdeschryver · 2019-04-19T20:26:17Z

projects/ngrx.io/content/guide/schematics/install.md

+
+Once you select `yes` you can notice below line added to `package.json`.
+
+`


Suggested change

`

```json

timdeschryver · 2019-04-19T20:26:36Z

projects/ngrx.io/content/guide/schematics/install.md

+`
+"cli": {
+    "defaultCollection": "@ngrx/schematics"
+}`


Suggested change

}`

}

timdeschryver · 2019-04-19T20:28:33Z

projects/ngrx.io/content/guide/schematics/install.md

+    "defaultCollection": "@ngrx/schematics"
+}`
+
+After this change you, are free to use any ngrx schematics without mentioning it


Suggested change

After this change you, are free to use any ngrx schematics without mentioning it

After this change you're able to use the NgRx schematics without the need to suffix the command, for example:

timdeschryver · 2019-04-19T20:28:59Z

projects/ngrx.io/content/guide/schematics/install.md

+
+After this change you, are free to use any ngrx schematics without mentioning it
+
+`ng g store State`


Suggested change

`ng g store State`

```bash

ng generate store State

timdeschryver · 2019-04-19T20:29:34Z

projects/ngrx.io/content/guide/schematics/install.md

+
+`ng g store State`
+
+the above command will create, a reducer file for us. you will notice a new file in `app/reducers`.


I think we can remove this line, as this isn't part of this schematic.

santoshyadavdev · 2019-04-22T06:01:27Z

Thanks Tim , will update the PR.

ngrxbot · 2019-04-23T11:19:26Z

Preview docs changes for 24705ff at https://previews.ngrx.io/pr1770-24705ff/

santoshyadavdev · 2019-04-23T11:35:22Z

Done with changes @timdeschryver you can review now.

brandonroberts · 2019-04-23T12:36:59Z

This install page needs to be more consistent with the other pages. See https://ngrx.io/guide/store/install for an example

santoshyadavdev · 2019-04-23T12:51:03Z

This install page needs to be more consistent with the other pages. See https://ngrx.io/guide/store/install for an example

Coo, will make the change

Fixes #1739

santoshyadavdev · 2019-04-23T13:28:23Z

changes done @brandonroberts

ngrxbot · 2019-04-23T13:41:43Z

Preview docs changes for d181120 at https://previews.ngrx.io/pr1770-d181120/

timdeschryver requested changes Apr 19, 2019

View reviewed changes

Docs: Add instructions for using ng add

d181120

Fixes #1739

brandonroberts approved these changes Apr 23, 2019

View reviewed changes

brandonroberts merged commit 2b83bef into ngrx:master Apr 23, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Add instructions for using ng add #1770

Docs: Add instructions for using ng add #1770

santoshyadavdev commented Apr 17, 2019

ngrxbot commented Apr 17, 2019

ngrxbot commented Apr 18, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

timdeschryver Apr 19, 2019

santoshyadavdev commented Apr 22, 2019

ngrxbot commented Apr 23, 2019

santoshyadavdev commented Apr 23, 2019

brandonroberts commented Apr 23, 2019

santoshyadavdev commented Apr 23, 2019 •

edited

Loading

santoshyadavdev commented Apr 23, 2019

ngrxbot commented Apr 23, 2019

	## Make @ngrx/scematics as default for app
	## Installing with `ng add`


		## Make @ngrx/scematics as default for app

		You can also make @ngrx/schematics as default for your app. Run below command inside an angular application from the root.

	You can also make @ngrx/schematics as default for your app. Run below command inside an angular application from the root.
	You can also make `@ngrx/schematics` the default collection for your application. Run the below command inside your Angular application from within the root.


		`Do you want to use @ngrx/schematics as the default collection?(y/n)`

		Once you select `yes` you can notice below line added to `package.json`.

	Once you select `yes` you can notice below line added to `package.json`.
	Once you select `yes` it will change the `defaultCollection` inside `angular.json`.

	After this change you, are free to use any ngrx schematics without mentioning it
	After this change you're able to use the NgRx schematics without the need to suffix the command, for example:


		After this change you, are free to use any ngrx schematics without mentioning it

		`ng g store State`


		`ng g store State`

		the above command will create, a reducer file for us. you will notice a new file in `app/reducers`.

Docs: Add instructions for using ng add #1770

Docs: Add instructions for using ng add #1770

Conversation

santoshyadavdev commented Apr 17, 2019

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

ngrxbot commented Apr 17, 2019

ngrxbot commented Apr 18, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

santoshyadavdev commented Apr 22, 2019

ngrxbot commented Apr 23, 2019

santoshyadavdev commented Apr 23, 2019

brandonroberts commented Apr 23, 2019

santoshyadavdev commented Apr 23, 2019 • edited Loading

santoshyadavdev commented Apr 23, 2019

ngrxbot commented Apr 23, 2019

santoshyadavdev commented Apr 23, 2019 •

edited

Loading