created angular mock service#175
Conversation
|
Thanks for submitting your work on a (new) tutorial! Some suggestions, which might help:
Also please find further help for creating tutorials here or more help regarding the tutorial syntax here. You can view the generated tutorials of this PR here in a few minutes. You just have to wait for the run of the deployment action to finish. When you think you are done writing the tutorial try the tutorial on the deveplopment area and check if you explained every step in a way someone who is trying to learn what you are teaching can understand. Ideally ask someone to have a look on what you have done and have that part double checked because this is very important. |
suprishi
left a comment
There was a problem hiding this comment.
Please check for incorrect spellings.
| @@ -0,0 +1,61 @@ | |||
| = Angular Mock Service | |||
There was a problem hiding this comment.
Rather than simply putting "Angular Mock Service", try to phrase an interesting title, so that users feel like checking out the tutorial.
Also put in a subtitle which briefly gives an idea about the tutorial.
| -- | ||
| restoreDevonfwIde(["ng", "npm", "vscode"]) | ||
| -- | ||
| First, clone the Devon4ng repository for Angular Mock Service Sample. |
There was a problem hiding this comment.
Why should a user clone it? We can't assume the user knows about the devon4ng repo and the samples that it contain.
Explain the topic in the first step (What is mock data, what is a mock service, why/when do we need it, why do we need to mock data, and so on).
And before asking the user to clone the sample, explain the sample also. (What is the sample about, how will we learn about mocking data using this sample, and so on).
|
|
||
| ==== | ||
| [step] | ||
| == Open Data-table component file |
There was a problem hiding this comment.
Why should a user open this file? Before asking the user to open the file, explain the concept that he/she will learn in this file.
And after asking the user to open the file, give the technical explanation on the parts of the code related to the topic.
|
|
||
| ==== | ||
| ## Conclusion | ||
| You have successfully cloned the sample angular mock service and learnt how a mock service works. |
There was a problem hiding this comment.
Cloning is not the scope of this tutorial, so you can remove this part "successfully cloned the sample angular mock service and".
Also you can list down the important points of the tutorial here, and provide the link to the sample repo.
|
|
||
| ==== | ||
| [step] | ||
| // == Open Data-table component file |
There was a problem hiding this comment.
Please remove the step if you don't need it. Don't comment it out, it is causing some syntax errors in the tutorial compiler.
| ## Conclusion | ||
| To conclude, in this tutorial you learned | ||
| * the concepts of mock data and services | ||
| * the mock architecture witrh the help of sample app |
There was a problem hiding this comment.
Please correct the spelling of "with" here.
suprishi
left a comment
There was a problem hiding this comment.
Please incorporate the following changes:
- Use
##instead of###for Prerequisites and Learning goals as per syntax. - Check syntax for using
== Mock dataas a step title, and try using###for section title instead of== Mock service - Remove "Note: In the SoapUI documentation, mocking can also be called isolation, virtualization, or simulation. All these terms refer to the same SoapUI feature"
- Correct spelling for board (instead of bord).
- Change "and" to "an" in "when the data comes with and API"
- Put screenshots of the pages of the app while providing their explanation.
- Clone the repository in the new step.
- Change title in step 2: Open Model file ==> Implementing mock data
- In step 2, open file first, then provide explanation. (So the sequence of functions become:
cloneRepository,openFile, and thendisplayContent). - Image is not loaded in step 2 (change png to jpg).
- In step 3, change the title: Open Service.ts file ==> Implementing mock service
- Provide some small explanation on the functions in the service.
What will the user learn in your tutorial?
What should the user already know when starting the tutorial?