Skip to content

created angular mock service#175

Merged
suprishi merged 26 commits intodevonfw-tutorials:mainfrom
akanagar:angular-mock-service
Oct 21, 2021
Merged

created angular mock service#175
suprishi merged 26 commits intodevonfw-tutorials:mainfrom
akanagar:angular-mock-service

Conversation

@akanagar
Copy link
Copy Markdown
Contributor

@akanagar akanagar commented Oct 4, 2021

What will the user learn in your tutorial?

What should the user already know when starting the tutorial?

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 4, 2021

Thanks for submitting your work on a (new) tutorial!

Some suggestions, which might help:

  • Title: Focus on what you want to train in a few words. Don't be too generic
  • Tutorial:
    • Address the user directly.
    • Explain why the steps are necessary.
    • Explain what are the results and why are they necessary for your next step.
    • Forward the user to more elaborate documentation on the website (deep links) for further reading

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.

Copy link
Copy Markdown
Contributor

@suprishi suprishi left a comment

Choose a reason for hiding this comment

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

Please check for incorrect spellings.

Comment thread angular-mock-service/index.asciidoc Outdated
@@ -0,0 +1,61 @@
= Angular Mock Service
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread angular-mock-service/index.asciidoc Outdated
--
restoreDevonfwIde(["ng", "npm", "vscode"])
--
First, clone the Devon4ng repository for Angular Mock Service Sample.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread angular-mock-service/index.asciidoc Outdated

====
[step]
== Open Data-table component file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread angular-mock-service/index.asciidoc Outdated

====
## Conclusion
You have successfully cloned the sample angular mock service and learnt how a mock service works.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread angular-mock-service/index.asciidoc Outdated

====
[step]
// == Open Data-table component file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread angular-mock-service/index.asciidoc Outdated
## Conclusion
To conclude, in this tutorial you learned
* the concepts of mock data and services
* the mock architecture witrh the help of sample app
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please correct the spelling of "with" here.

Copy link
Copy Markdown
Contributor

@suprishi suprishi left a comment

Choose a reason for hiding this comment

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

Please incorporate the following changes:

  1. Use ## instead of ### for Prerequisites and Learning goals as per syntax.
  2. Check syntax for using == Mock data as a step title, and try using ### for section title instead of == Mock service
  3. Remove "Note: In the SoapUI documentation, mocking can also be called isolation, virtualization, or simulation. All these terms refer to the same SoapUI feature"
  4. Correct spelling for board (instead of bord).
  5. Change "and" to "an" in "when the data comes with and API"
  6. Put screenshots of the pages of the app while providing their explanation.
  7. Clone the repository in the new step.
  8. Change title in step 2: Open Model file ==> Implementing mock data
  9. In step 2, open file first, then provide explanation. (So the sequence of functions become: cloneRepository, openFile, and then displayContent).
  10. Image is not loaded in step 2 (change png to jpg).
  11. In step 3, change the title: Open Service.ts file ==> Implementing mock service
  12. Provide some small explanation on the functions in the service.

@akanagar akanagar marked this pull request as ready for review October 21, 2021 10:27
@suprishi suprishi merged commit 61a36a1 into devonfw-tutorials:main Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants