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.

Sign up for GitHub

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

Jump to bottom

docs: Add overview page for @ngrx/data #1767

Merged
merged 7 commits into from
Apr 22, 2019
Merged

docs: Add overview page for @ngrx/data #1767

merged 7 commits into from
Apr 22, 2019

Conversation

jtcrowson
Copy link
Contributor

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?

Closes #1749

What is the new behavior?

  • Adds overview section
  • Describes what @ngrx/data is
  • Key concepts
  • Usage

Does this PR introduce a breaking change?

[ ] Yes
[x] No

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 17, 2019

Preview docs changes for 7b71449 at https://previews.ngrx.io/pr1767-7b71449/

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 17, 2019

Preview docs changes for 2173810 at https://previews.ngrx.io/pr1767-2173810/

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 17, 2019

Preview docs changes for eedecca at https://previews.ngrx.io/pr1767-eedecca/

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 17, 2019

Preview docs changes for c81bfef at https://previews.ngrx.io/pr1767-c81bfef/

@timdeschryver timdeschryver mentioned this pull request Apr 19, 2019
Merged
3 tasks
timdeschryver
timdeschryver requested changes Apr 19, 2019
View reviewed changes
Copy link
Member

@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.

Not for this PR, but should we also migrate the docs? ngrx-data has a rich documentation -https://github.com/johnpapa/angular-ngrx-data/tree/master/docs

projects/ngrx.io/content/guide/data/index.md Outdated Show resolved Hide resolved
@timdeschryver
docs: fix misspelling of heroes
5457629 
Co-Authored-By: jtcrowson <John.Crowson@CapitalOne.com>
@jtcrowson
Copy link
Contributor Author

@timdeschryver definitely. I basically summarized that documentation in this PR. Do we want to credit the original project somewhere?

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 19, 2019

Preview docs changes for 5457629 at https://previews.ngrx.io/pr1767-5457629/

@jtcrowson jtcrowson mentioned this pull request Apr 19, 2019
Closed
brandonroberts
brandonroberts requested changes Apr 20, 2019
View reviewed changes
projects/ngrx.io/content/guide/data/index.md Outdated
@@ -0,0 +1,143 @@
# NgRx Data

NgRx Data is an extension that offers a gentle introduction to NgRx by simplifying management of **entity data** while reducing the amount of boilerplate.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
NgRx Data is an extension that offers a gentle introduction to NgRx by simplifying management of **entity data** while reducing the amount of boilerplate.
NgRx Data is an extension that offers a gentle introduction to NgRx by simplifying management of **entity data** while reducing the amount of explicitness.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 5ef16b0.

Copy link
Contributor Author

@jtcrowson jtcrowson Apr 22, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

<insert @brandonroberts yelling boilerplate .gif> 😂

projects/ngrx.io/content/guide/data/index.md Outdated

In even a small model, this is a ton of repetitive code to create, maintain, and test.

NgRx Data allows consumers to use NgRx while radically reducing the boilerplate necessary to manage entities with NgRx.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
NgRx Data allows consumers to use NgRx while radically reducing the boilerplate necessary to manage entities with NgRx.
NgRx Data allows consumers to use NgRx while radically reducing the explicitness necessary to manage entities with NgRx.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 5ef16b0.

projects/ngrx.io/content/guide/data/index.md Outdated

## Defining the entities

We create an `EntityMetadataMap` to tell NgRx Data about our entities. Add a property to the set for each entity name.
Copy link
Member

Choose a reason for hiding this comment

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

Change the references from We and our to You and your

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in 5ef16b0.

@ngrxbot
Copy link
Collaborator

ngrxbot commented Apr 22, 2019

Preview docs changes for c8ae647 at https://previews.ngrx.io/pr1767-c8ae647/

@brandonroberts brandonroberts merged commit 916f190 into ngrx:master Apr 22, 2019
@brandonroberts brandonroberts mentioned this pull request Apr 22, 2019
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timdeschryver timdeschryver timdeschryver approved these changes

@brandonroberts brandonroberts brandonroberts approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Add overview page for @ngrx/data
4 participants
@jtcrowson @ngrxbot @brandonroberts @timdeschryver