fix(docs): update TodoList tutorial #4126

dhmlau · 2019-11-14T14:16:19Z

Now that we have lb4 relation command, we need to update the TodoList tutorial to remove the manual steps because those are taken care by the relation generator command.

I've shuffled around the content a bit so a good portion of it are existing content.
The TodoList tutorial also has the hasOne portion but since we don't have the hasOne option available on lb4 relation (see Add hasOne relation type to lb4 relation #2980), I didn't update the tutorial to include that.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
API Documentation in code was updated
Documentation in /docs/site was updated
Affected artifact templates in packages/cli were updated
Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

agnes512

Thanks for adding the usage of relation generator to the tutorial! Mostly LGTM, just have some comments.

docs/site/sidebars/lb4_sidebar.yml

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

docs/site/tutorials/todo-list/todo-list-tutorial-repository.md

agnes512 · 2019-11-14T15:36:09Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

+#### Inclusion of Related Models
+
+When running the `lb4 relation` command, the prompt below registers the
+inclusionResolver for this belongsTo relation for you.


inclusionResolver -> inclusionResolver

Here it seems we are asking user to run it again.

When running the lb4 relation command, the prompt below registers the
inclusionResolver for this belongsTo relation for you.

We need to rewrite this paragraph in the proper tense.

Perhaps something like:

When we ran the lb4 relation commands above, we accepted the default of Yes to the prompt:

? Allow Order queries to include data from related Customer instances? (Y/n)

This registered the inclusionResolver for the relation(s) you were working with above.

Make sure to chose yes ...

docs/site/sidebars/lb4_sidebar.yml

emonddr · 2019-11-14T16:02:21Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

+
+#### Relation decorators
+
+When specifying the `hasMany` relation, it adds `@hasMany()` decorator defines


When specifying the hasMany relation, it adds @hasMany() decorator defines this property.

What are we trying to say here?

trying to say when running the lb4 relation command, the decorator was added to the property. Let me do some rewording here.

emonddr · 2019-11-14T16:11:45Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

+#### Inclusion of Related Models
+
+When running the `lb4 relation` command, the prompt below registers the
+inclusionResolver for this belongsTo relation for you.


Here it seems we are asking user to run it again.

When running the lb4 relation command, the prompt below registers the
inclusionResolver for this belongsTo relation for you.

We need to rewrite this paragraph in the proper tense.

Perhaps something like:

When we ran the lb4 relation commands above, we accepted the default of Yes to the prompt:

? Allow Order queries to include data from related Customer instances? (Y/n)

This registered the inclusionResolver for the relation(s) you were working with above.

Make sure to chose yes ...

docs/site/sidebars/lb4_sidebar.yml

jannyHou · 2019-11-14T17:52:44Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

+
+On the other end,
+[`BelongsToAccessor`](https://loopback.io/doc/en/lb4/apidocs.repository.belongstoaccessor.html)
+also comes with an inclusion resolver property that we can register on the


nitpick: I feel a more accurate word is function instead of property.

changed it to function.

emonddr · 2019-11-14T20:51:42Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

-When specifying the `hasMany` relation, it adds `@hasMany()` decorator defines
-this property. As the decorator's name suggests, `@hasMany()` informs LoopBack 4
-that a todo list can have many todo items.
+When we added the `hasMany` relation using the `lb4 relation` command, it added


When we added the hasMany relation using the lb4 relation command, it added
@hasMany() decorator defines this property

When we added the hasMany relation using the lb4 relation command, it added the
@hasMany() decorator which defines this property . (Is this what we want to say?)

actually, it added the property + the decorator. How about:

When we added the hasMany relation using the lb4 relation command, it added the
@hasMany() decorator together with the todo property.

actually, it added the property + the decorator. How about:

When we added the hasMany relation using the lb4 relation command, it added the
@hasMany() decorator together with the todo property.

todo or todos ? The line below says:

Also, we still need a the before '@hasmany decorator'

it should be todos property (the one in the documentation is correct).

OK. how about this:

When we added the hasMany relation using the lb4 relation command, it added
the @hasMany() decorator together with the todos property.

dhmlau · 2019-11-15T14:56:22Z

@emonddr, please see my latest commit 24e80aa that addressed your comment. Thanks!

emonddr · 2019-11-15T15:19:08Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

-When specifying the `hasMany` relation, it adds `@hasMany()` decorator defines
-this property. As the decorator's name suggests, `@hasMany()` informs LoopBack 4
-that a todo list can have many todo items.
+When we added the `hasMany` relation using the `lb4 relation` command, it added


actually, it added the property + the decorator. How about:

When we added the hasMany relation using the lb4 relation command, it added the
@hasMany() decorator together with the todo property.

todo or todos ? The line below says:

emonddr · 2019-11-15T15:22:22Z

docs/site/tutorials/todo-list/todo-list-tutorial-relations.md

-When specifying the `hasMany` relation, it adds `@hasMany()` decorator defines
-this property. As the decorator's name suggests, `@hasMany()` informs LoopBack 4
-that a todo list can have many todo items.
+When we added the `hasMany` relation using the `lb4 relation` command, it added


Also, we still need a the before '@hasmany decorator'

dhmlau · 2019-11-15T15:54:11Z

@emonddr, I've pushed my changes and squashed all the commits. PTAL again. Thanks!

emonddr

:)

dhmlau requested review from bajtos and raymondfeng as code owners November 14, 2019 14:16

dhmlau requested a review from agnes512 November 14, 2019 14:38

dhmlau added the Docs label Nov 14, 2019

agnes512 reviewed Nov 14, 2019

View reviewed changes

emonddr suggested changes Nov 14, 2019

View reviewed changes

jannyHou reviewed Nov 14, 2019

View reviewed changes

jannyHou approved these changes Nov 14, 2019

View reviewed changes

emonddr suggested changes Nov 14, 2019

View reviewed changes

agnes512 approved these changes Nov 15, 2019

View reviewed changes

emonddr suggested changes Nov 15, 2019

View reviewed changes

fix(docs): update TodoList tutorial

c7f98e9

dhmlau force-pushed the relation branch from 24e80aa to c7f98e9 Compare November 15, 2019 15:53

emonddr approved these changes Nov 15, 2019

View reviewed changes

dhmlau merged commit 947835d into master Nov 15, 2019

dhmlau deleted the relation branch November 15, 2019 16:11

dhmlau self-assigned this Nov 15, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): update TodoList tutorial #4126

fix(docs): update TodoList tutorial #4126

dhmlau commented Nov 14, 2019 •

edited

Loading

agnes512 left a comment

agnes512 Nov 14, 2019

emonddr Nov 14, 2019

emonddr Nov 14, 2019

dhmlau Nov 14, 2019

emonddr Nov 14, 2019

jannyHou Nov 14, 2019

dhmlau Nov 14, 2019

emonddr Nov 14, 2019

dhmlau Nov 15, 2019 •

edited

Loading

emonddr Nov 15, 2019

emonddr Nov 15, 2019

dhmlau Nov 15, 2019

dhmlau commented Nov 15, 2019

emonddr Nov 15, 2019

emonddr Nov 15, 2019

dhmlau commented Nov 15, 2019

emonddr left a comment


		#### Relation decorators

		When specifying the `hasMany` relation, it adds `@hasMany()` decorator defines

fix(docs): update TodoList tutorial #4126

fix(docs): update TodoList tutorial #4126

Conversation

dhmlau commented Nov 14, 2019 • edited Loading

Checklist

agnes512 left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhmlau Nov 15, 2019 • edited Loading

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

dhmlau commented Nov 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhmlau commented Nov 15, 2019

emonddr left a comment

Choose a reason for hiding this comment

dhmlau commented Nov 14, 2019 •

edited

Loading

dhmlau Nov 15, 2019 •

edited

Loading