From dfaef318469d99047ae6ca23a62f0f77a894350d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20G=C3=BCnther?= Date: Wed, 17 Feb 2021 16:10:54 +0100 Subject: [PATCH 1/4] added link to tutorial code in intro --- runners/katacoda/index.ts | 3 ++- runners/katacoda/templates/intro.md | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 runners/katacoda/templates/intro.md diff --git a/runners/katacoda/index.ts b/runners/katacoda/index.ts index 7dd0298d..de024acd 100644 --- a/runners/katacoda/index.ts +++ b/runners/katacoda/index.ts @@ -52,7 +52,8 @@ export class Katacoda extends Runner { } destroy(playbook: Playbook): void { - fs.writeFileSync(this.outputPathTutorial + 'intro.md', playbook.description); + let tutorialDirectoryName = path.basename(playbook.path); + this.renderTemplate("intro.md", path.join(this.outputPathTutorial, "intro.md"), { description: playbook.description, tutorialPath: tutorialDirectoryName }); fs.writeFileSync(this.outputPathTutorial + 'finish.md', ""); // create and configure required files for the setup process diff --git a/runners/katacoda/templates/intro.md b/runners/katacoda/templates/intro.md new file mode 100644 index 00000000..c0a1c71b --- /dev/null +++ b/runners/katacoda/templates/intro.md @@ -0,0 +1,5 @@ +<%= description; %> + +<% if(tutorialPath){ %> +You can find the source code of this tutorial on https://github.com/devonfw-tutorials/katacoda-scenarios/tree/master/<%= tutorialPath; %> +<% } %> \ No newline at end of file From f47302e9b9717d952cd68849aa3bc8062e2aa395 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20G=C3=BCnther?= Date: Thu, 18 Feb 2021 11:42:22 +0100 Subject: [PATCH 2/4] changed description --- runners/katacoda/templates/intro.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/runners/katacoda/templates/intro.md b/runners/katacoda/templates/intro.md index c0a1c71b..4152bfce 100644 --- a/runners/katacoda/templates/intro.md +++ b/runners/katacoda/templates/intro.md @@ -1,5 +1,7 @@ <%= description; %> <% if(tutorialPath){ %> -You can find the source code of this tutorial on https://github.com/devonfw-tutorials/katacoda-scenarios/tree/master/<%= tutorialPath; %> +The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/katacoda-scenarios/tree/master/<%= tutorialPath; %> + +Feel free to fix any errors you find yourself. You just need to create a pull request to the katacoda-scenarios repository with the changed files. <% } %> \ No newline at end of file From 58620c77724604b73a0032f81c80d2da40f22228 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20G=C3=BCnther?= Date: Tue, 23 Feb 2021 11:10:21 +0100 Subject: [PATCH 3/4] added link to contribution guide --- runners/katacoda/templates/intro.md | 1 + 1 file changed, 1 insertion(+) diff --git a/runners/katacoda/templates/intro.md b/runners/katacoda/templates/intro.md index 4152bfce..be9cb912 100644 --- a/runners/katacoda/templates/intro.md +++ b/runners/katacoda/templates/intro.md @@ -4,4 +4,5 @@ The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/katacoda-scenarios/tree/master/<%= tutorialPath; %> Feel free to fix any errors you find yourself. You just need to create a pull request to the katacoda-scenarios repository with the changed files. +You can find a description of what to look for when creating a pull request at the devonfw contribution guide: https://devonfw.com/website/pages/docs/CONTRIBUTING.asciidoc.html#contributing.asciidoc_pull-requests <% } %> \ No newline at end of file From f40627afc3950d2e4f30db9160037ff6d7dff4d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20G=C3=BCnther?= Date: Thu, 11 Mar 2021 15:45:56 +0100 Subject: [PATCH 4/4] changed url to github --- runners/katacoda/templates/intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/runners/katacoda/templates/intro.md b/runners/katacoda/templates/intro.md index be9cb912..a3eb2579 100644 --- a/runners/katacoda/templates/intro.md +++ b/runners/katacoda/templates/intro.md @@ -1,8 +1,8 @@ <%= description; %> <% if(tutorialPath){ %> -The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/katacoda-scenarios/tree/master/<%= tutorialPath; %> +The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/tutorials/tree/main/<%= tutorialPath; %> -Feel free to fix any errors you find yourself. You just need to create a pull request to the katacoda-scenarios repository with the changed files. +Feel free to fix any errors you find yourself. You just need to create a pull request to the tutorials repository with your changes. You can find a description of what to look for when creating a pull request at the devonfw contribution guide: https://devonfw.com/website/pages/docs/CONTRIBUTING.asciidoc.html#contributing.asciidoc_pull-requests <% } %> \ No newline at end of file