Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Various minor fixes to the Definition of DONE #328

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Various minor fixes to the Definition of DONE #328

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3e05c82
Update Definition of DONE.md
mustafaokyay Aug 27, 2021
f37e370
Update Definition of DONE.md
mustafaokyay Sep 9, 2021
8b92210
Update Definition of DONE.md
mustafaokyay Sep 29, 2021
0c9b705
Update Definition of DONE.md
mustafaokyay Sep 29, 2021
f2b1679
Update Definition of DONE.md
mustafaokyay Sep 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions documentation/Definition of DONE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# **General**
* I kept the name of my tutorial short. For a small explanation of my tutorial, I used sub-topics.
* I used a higher header level for Prerequisites and Learning goals.
* I described what I wanted to train in a few words and clearly state the objective of my tutorial. This should give the reader an idea of what to expect from my tutorial and help them to determine if they really want to learn this topic.
* I addressed the user directly.
* I was clear and concise in my writing.
Expand All @@ -9,15 +10,15 @@
* I rather made many small steps than a few big steps.
* I used images and code examples in my tutorial which were provided in the devonfw documentation. Plain text gets boring after time.
* I used an organized structure in my tutorial.
* All the things that the user should do actively, I have always written with function calls and steps . I have not given any instructions for action in text form.
* Things that the user should do actively, I have written with function calls and steps. I have not given any instructions for actions in text form.
* I proofread my tutorial:
1. Are the steps available and in the correct order?
1. Are there any spelling mistakes?
1. Does everything make sense?
* I ran through the latest update of my tutorial in Katacoda-Dev and checked if everything was working as intended BEFORE requesting a review.

# **Technical**
* The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. `nextKatacodaStep` is almost never needed.
* Do not use Katacoda-Syntax inside the files. Use `displayContent`.
* Commands like `--- cd devonfw {{execute T1}} ---` should not be used, as it could break certain functions.

# Different types of tutorials
Expand All @@ -42,4 +43,4 @@
### Only for Try Out-tutorials:

* I wanted to showcase a certain sample project/feature and its capabilities in a fast and straightforward way to the reader. Example: Tutorial for launching MyThaiStar, so the reader can click through it, and see what is possible.
* I provided little explanation of the things done in the tutorial.
* I provided only little explanation of the things done in the tutorial.