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

docs: add features and migrations #1776

Merged
merged 3 commits into from
Apr 23, 2019
Merged

Conversation

timdeschryver
Copy link
Member

PR Checklist

Please check if your PR fulfills the following requirements:

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?

Follow up to #1757 (coming from #1701)

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Copy link
Member Author

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there another feature that needs to be added?
Should we provide more information to the new features, or is it sufficient to point to the docs?


### `META_REDUCERS` token
- [@ngrx/data](): the [angular-ngrx-data](https://github.com/johnpapa/angular-ngrx-data) library by John Papa and Ward Bell is now an official part of NgRx and can be installed with `npm install @ngrx/data`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once #1767 is merged, we can point to the docs. (build is failing at the moment because the url does not exist yet)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just point people to the blog post and keep the migration guide for breaking changes?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea, we go a little deeper in the blog post, so it's probably better to just point to it 👍

- [`strictImmutability`](/guide/store/configuration/runtime-checks#strictimmutability): verifies that the state and actions aren't being mutated
- [`strictStateSerializability`](/guide/store/configuration/runtime-checks#strictstateserializability): verifies if the state is serializable
- [`strictActionSerializability`](/guide/store/configuration/runtime-checks#strictactionserializability): verifies if the actions are serializable
- [mock selectors](): mock selectors for a fully isolated unit test
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting on #1761

projects/ngrx.io/content/guide/migration/v8.md Outdated Show resolved Hide resolved

### `META_REDUCERS` token
- [@ngrx/data](): the [angular-ngrx-data](https://github.com/johnpapa/angular-ngrx-data) library by John Papa and Ward Bell is now an official part of NgRx and can be installed with `npm install @ngrx/data`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just point people to the blog post and keep the migration guide for breaking changes?

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 22, 2019

Preview docs changes for a2f9c9b at https://previews.ngrx.io/pr1776-a2f9c9b/

@brandonroberts
Copy link
Member

brandonroberts commented Apr 22, 2019

Once the features section is removed, I think everything looks good 👍 .

@timdeschryver
Copy link
Member Author

What about the @ngrx/data renames and migrations?
Should we add them in the PR, or add them in #1782 ?

@brandonroberts
Copy link
Member

Add them in #1782

@timdeschryver timdeschryver marked this pull request as ready for review April 22, 2019 20:46
@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 22, 2019

Preview docs changes for 51887db at https://previews.ngrx.io/pr1776-51887db/

@brandonroberts brandonroberts merged commit be106c9 into master Apr 23, 2019
@brandonroberts brandonroberts deleted the pr/v8-migration-features branch April 23, 2019 02:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants