Skip to content

Commit 9552e82

Browse files
changed some text
1 parent 2e0911d commit 9552e82

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

tutorial-compiler/files/createPullRequest1.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Before starting write content into the tutorial, you have to create a pull request from your newly created branch into the main repository.
2-
This has the advantage that your tutorial will automatically be build and pushed to https://katacoda.com/devonfw-dev. So you can directly check it out.
2+
This has the advantage that your tutorial will automatically be build and pushed to https://katacoda.com/devonfw-dev. So you can directly test it.
33

44
For this step you need to open you local terminal at your forked and cloned 'tutorials' folder and run the following commands:
55
1. 'git add .'

tutorial-compiler/files/localTesting.md

+5
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,8 @@ To run the tutorial-compiler execute the following command:
2727
`bash localBuildRun.sh -e katacoda -p myTutorial`{{execute T1}}
2828

2929
This will execute your newly create tutorial in the 'katacoda' environment. If you obmit the '-e' and '-p' paramter, all tutorials are executed in all environments.
30+
31+
The tutorial-compiler will now create the files needed for a katacoda tutorial. You can find the files in the 'build/output/katacoda/myTutorial' directory of the tutorial-compiler.
32+
The step you added to your tutorial will be displayed in the following file:
33+
34+
`tutorial-compiler/build/output/katacoda/myTutorial/step1.md`{{open}}

tutorial-compiler/index.asciidoc

+5
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ nextKatacodaStep("Fork the tutorials repository", [{"image": "images/fork.jpg"},
3131

3232

3333
Paste the URL to the 'git clone' command to clone the repostitory. For this tutorial we will use the original tutorials repository of the 'devonfw-tutorials' GitHub account to show the workflow of creating the tutorial.
34+
35+
When you run the command on your machine, you will of course need to customize the URL and add your personal GitHub name. So the command will be 'git clone https://github.com/YourName/tutorials.git'.
3436
[step]
3537
== Clone the repository
3638
--
@@ -84,12 +86,15 @@ Each step consists of
8486
* a function to execute (You can find a list with the currently available functions on https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions)
8587
* and an optional explanation of the results of the step.
8688
89+
====
8790
In this tutorial we will add a simple step which creates a new file.
8891
[step]
8992
== Add a step
9093
--
9194
changeFile("tutorials/myTutorial/index.asciidoc", {"file": "files/step.txt" })
9295
--
96+
This is the syntax without additional text after the step. There is an alternative syntax to display a text after the step (e.g. for describing the results of a step). This will be shown in the next step.
97+
====
9398

9499
[step]
95100
--

0 commit comments

Comments
 (0)