From 3e05c8297eaee83981b34a47008fb7c2779cbd29 Mon Sep 17 00:00:00 2001 From: mustafaokyay <57177008+mustafaokyay@users.noreply.github.com> Date: Fri, 27 Aug 2021 13:57:50 +0200 Subject: [PATCH 1/5] Update Definition of DONE.md --- documentation/Definition of DONE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/Definition of DONE.md b/documentation/Definition of DONE.md index 02245320..2c9e6dd6 100644 --- a/documentation/Definition of DONE.md +++ b/documentation/Definition of DONE.md @@ -17,7 +17,7 @@ * 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. +* The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. `nextKatacodaStep` should not be used. * Commands like `--- cd devonfw {{execute T1}} ---` should not be used, as it could break certain functions. # Different types of tutorials From f37e370f1abaab6ed29e0fc555bb7bd69414e994 Mon Sep 17 00:00:00 2001 From: mustafaokyay <57177008+mustafaokyay@users.noreply.github.com> Date: Thu, 9 Sep 2021 10:50:02 +0200 Subject: [PATCH 2/5] Update Definition of DONE.md --- documentation/Definition of DONE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/Definition of DONE.md b/documentation/Definition of DONE.md index 2c9e6dd6..95f0c42c 100644 --- a/documentation/Definition of DONE.md +++ b/documentation/Definition of DONE.md @@ -9,7 +9,7 @@ * 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? @@ -17,7 +17,8 @@ * 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` should not be used. +* The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. +* The name of the function `nextKatacodaStep ` has been changed to make it clearer that there is no functional content allowed. Now it is called `displayContent ` * Commands like `--- cd devonfw {{execute T1}} ---` should not be used, as it could break certain functions. # Different types of tutorials @@ -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. From 8b922107f529659332a143e27917284593accb2d Mon Sep 17 00:00:00 2001 From: mustafaokyay <57177008+mustafaokyay@users.noreply.github.com> Date: Wed, 29 Sep 2021 14:12:33 +0200 Subject: [PATCH 3/5] Update Definition of DONE.md --- documentation/Definition of DONE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/Definition of DONE.md b/documentation/Definition of DONE.md index 95f0c42c..785d3f60 100644 --- a/documentation/Definition of DONE.md +++ b/documentation/Definition of DONE.md @@ -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. @@ -18,7 +19,7 @@ # **Technical** * The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. -* The name of the function `nextKatacodaStep ` has been changed to make it clearer that there is no functional content allowed. Now it is called `displayContent ` +* 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 From 0c9b7051140a8188cd1905310f815bd21a1e95b1 Mon Sep 17 00:00:00 2001 From: mustafaokyay <57177008+mustafaokyay@users.noreply.github.com> Date: Wed, 29 Sep 2021 14:13:01 +0200 Subject: [PATCH 4/5] Update Definition of DONE.md --- documentation/Definition of DONE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/Definition of DONE.md b/documentation/Definition of DONE.md index 785d3f60..fef2d54d 100644 --- a/documentation/Definition of DONE.md +++ b/documentation/Definition of DONE.md @@ -19,7 +19,7 @@ # **Technical** * The files that were used in `nextKatacodaStep `are available in `.asciidoc` files and do not contain Katacoda Syntax. -* Do not use Katacoda-Syntax inside the files. ` Use displayContent`. +* 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 From f2b16793c3e133a6769d91192260d55a250d45f1 Mon Sep 17 00:00:00 2001 From: mustafaokyay <57177008+mustafaokyay@users.noreply.github.com> Date: Wed, 29 Sep 2021 14:14:05 +0200 Subject: [PATCH 5/5] Update Definition of DONE.md --- documentation/Definition of DONE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/documentation/Definition of DONE.md b/documentation/Definition of DONE.md index fef2d54d..a75068e2 100644 --- a/documentation/Definition of DONE.md +++ b/documentation/Definition of DONE.md @@ -18,7 +18,6 @@ * 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. * 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.