You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please mark your pull request as draft until it is finished: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft
Copy file name to clipboardExpand all lines: .github/workflows/pr.yml
+16-1Lines changed: 16 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,22 @@ jobs:
15
15
repo-token: ${{ secrets.GITHUB_TOKEN }}
16
16
repo-token-user-login: 'github-actions[bot]'
17
17
message: |
18
-
You can view the generated tutorials of this PR on https://www.katacoda.com/devonfw-dev in a few minutes. You just have to wait for the next run of the deployment action https://github.com/devonfw-tutorials/katacoda-scenarios-dev/actions
18
+
Thanks for submitting your work on a (new) tutorial!
19
+
20
+
Some suggestions, which might help:
21
+
22
+
- Title: Focus on what you want to train in a few words. Don't be too generic
23
+
- Tutorial:
24
+
- Address the user directly.
25
+
- Explain why the steps are necessary.
26
+
- Explain what are the results and why are they necessary for your next step.
27
+
- Forward the user to more elaborate documentation on the website (deep links) for further reading
28
+
29
+
Also please find further help for creating tutorials [here](https://www.katacoda.com/devonfw/scenarios/create-your-own-tutorial) or more help regarding the tutorial syntax [here](https://github.com/devonfw-tutorials/tutorials/wiki/Development).
30
+
31
+
You can view the generated tutorials of this PR [here](https://www.katacoda.com/devonfw-dev) in a few minutes. You just have to wait for the run of the [deployment action](https://github.com/devonfw-tutorials/katacoda-scenarios-dev/actions) to finish.
32
+
33
+
When you think you are done writing the tutorial try the tutorial on the [deveplopment area](https://www.katacoda.com/devonfw-dev) 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.
0 commit comments