Skip to content

Add Ember Data flexibility section #240

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

Merged
merged 3 commits into from
Nov 20, 2018

Conversation

ppcano
Copy link
Contributor

@ppcano ppcano commented Nov 2, 2018

The change splits the section What are Ember Data models? in two parts:

  • What are Ember Data models?
  • Ember Data flexibility

I described the reasons for this change on the When to add Ember Data discussion.

Some folks decided to provide a JSON-API backend because Ember Data uses it as a default format, and this added more work for them. I think extending the REST adapter and use a conventional REST backend would have been a better choice for them.

This made me think how the documentation of the default format of Ember Data is communicated or may be interpreted.

@jenweber suggested creating small incremental PRs, so this is a small change to highlight more the existing content around the "Flexibility" capabilities that was included in the What are Ember Data models?.

Additionally, I also thought about:

  1. extend a little more the Ember Data flexibility section.

  2. Tweak the content of the Convention Over Configuration with JSON API section.

But I didn't want to include more changes without validating if there is a shared opinion on the topic.

Relates to #20

Copy link
Contributor

@zachgarwood zachgarwood left a comment

Choose a reason for hiding this comment

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

I think adding the new section makes sense. My only criticism is the ambiguity of the statement: "This will allow your code to evolve without becoming a mess." I think something that explains the nature of the "mess" would be better: "This will allow your code to evolve while encapsulating data retrieval and maintaining complex relationships between various data objects."

Copy link
Contributor

@jenweber jenweber left a comment

Choose a reason for hiding this comment

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

Just a couple wording tweaks. Thanks for writing this! I think it is helpful context.

Jen Weber and others added 2 commits November 10, 2018 19:10
Co-Authored-By: ppcano <pepe@loadimpact.com>
Co-Authored-By: ppcano <pepe@loadimpact.com>
@ppcano
Copy link
Contributor Author

ppcano commented Nov 10, 2018

@jenweber Thanks for reviewing it. The requested changes are done.

What are the thoughts about?

  1. Extend a little more the Ember Data flexibility section.

  2. Tweak/review the content of the Convention Over Configuration with JSON API section.

I commented previously on this discussion that I think it could be a good idea if the the docs promotes more the "Flexibility" of Ember Data and a "little less" the benefits of using JSON/API as default format.

If there is an community agreement on this suggestion, I can try to tweak the content with small PRs.

@jenweber jenweber merged commit 47abb6b into ember-learn:master Nov 20, 2018
@jenweber
Copy link
Contributor

@ppcano I like both of these ideas. Want to give a rough draft a try and PR it? We can also run some questions by the Ember Data team to get their vision on these points.

Also, we have been kinda moving away from the "Convention over configuration" type language because it doesn't really seem to resonate anymore, so maybe you could help improve that too.

The JSONAPI section was probably written when the project was brand-new. I have a feeling that we can keep the same content level with fewer words, now that the project is better established and known.

jaredgalanis pushed a commit to jaredgalanis/guides-source that referenced this pull request Feb 10, 2019
* Add `Ember Data flexibility` section

* Update guides/v3.5.0/models/index.md

Co-Authored-By: ppcano <pepe@loadimpact.com>

* Update guides/v3.5.0/models/index.md

Co-Authored-By: ppcano <pepe@loadimpact.com>
cspanring pushed a commit to cspanring/guides-source that referenced this pull request Apr 12, 2019
* Add `Ember Data flexibility` section

* Update guides/v3.5.0/models/index.md

Co-Authored-By: ppcano <pepe@loadimpact.com>

* Update guides/v3.5.0/models/index.md

Co-Authored-By: ppcano <pepe@loadimpact.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants