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..a3eb2579 --- /dev/null +++ b/runners/katacoda/templates/intro.md @@ -0,0 +1,8 @@ +<%= description; %> + +<% if(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 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