ember-learn / ember-learn/ember-website

[tutorial] suggested change for unclear phrasing

Open
#1,113 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
95
Forks
199
Avg merge
1d 2h
Merged PRs (30d)
14

Description

[The wording in the ember tutorial here](https://guides.emberjs.com/release/tutorial/part-2/ember-data/) where it states "To make this store service available, we must add the following file:
`export { default } from 'ember-data/store';`" is unclear what the next step for the learner is. Is it ok to change the wording here to say something to the effect of "To make this store service available, first we much create a service folder, and in a file `service/service.js` put the following code". Or like in the other parts of the tutorial, have the banner above the code specifiy the file path, as it current does not display a file path and only shows the string of code:

Screenshot 2024-05-23 at 12 42 32 PM

I apologize if there is a github representation of the tutorial where i could have better referenced the text for this issue. i tried looking in the [ember-website](https://github.com/ember-learn/ember-website) codebase and didnt find anything regarding the tutorial content in there, so if this is the wrong place and if someone could point me in the right direction that would be great, and id gladly reopen the issue! Im also a newbie to ember, so sorry if it is, in fact, there!

Contributor guide

Open the contributing guide

Research direction

Start with the referenced Ember tutorial page in the ember-website repository and locate the source for the Ember Data tutorial content; the issue does not identify a file. Review the wording and code-block presentation around the store service, then update it so the required path and next step are explicit. Done means the tutorial clearly tells learners where to place the code.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.