Merge pull request devonfw-tutorials#247 from EduardKrieger/refactoring/spellingConvention

refactoring/spellingConventionAndHeadertypes

Author: denise-khuu

runners/wikiConsole/templates/buildJava.asciidoc

@@ -1,12 +1,11 @@
-Build the Java Project with Maven
-=================================
+== Build the Java Project with Maven
+
+=== Prerequisites
 
-Prerequisites
-~~~~~~~~~~~~~
 * You need to have Maven installed. If not already installed, you can download it https://maven.apache.org/download.cgi[here]. Alternativly, you can make use of the devonfw-ide, where you can install Maven directly to your workspace. For more details on how to do that, see the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html#setup.asciidoc[devonfw-ide setup].
 
-Execution
-~~~~~~~~~
+=== Execution
+
 Now move to your project directory manually or by executing `cd <%= directoryPath; %>` in the terminal.
 Next, use the following command to build the java project.
 

runners/wikiConsole/templates/buildNg.asciidoc

@@ -1,15 +1,13 @@
-Build an Angular Project
-========================
+== Build an Angular Project
 
-Prerequisites
-~~~~~~~~~~~~~~
+
+=== Prerequisites
 * You need to have either installed the devonfw-ide with an Angular installation or installed https://angular.io/[Angular] seperatly on your system.
-* You need to have created or downloaded a Angular Project to a local directory.
+* You need to have created or downloaded a Angular project to a local directory.
 
 For this tutorial navigate to the Angular directory by executing `cd <%= angularPath; %>` in your terminal.
 
-Execution
-~~~~~~~~~
+=== Execution
 <% if(outputPath){ %>
 If you want to compile the app to a custom output directory, you can execute the command `ng build --output-path <%= outputPath; %>`. The output path must me relative to your current workspace.
 <% } else { %>

runners/wikiConsole/templates/changeFile.asciidoc

@@ -3,8 +3,7 @@
 
 === Changing of <%= fileName; %> from command prompt
 
-
-Changing a file can be done in an editor like VSCode or Eclipse. Another approach is to use the command prompt. We show how to insert, append or replace some data in a file using the command prompt on either Windows or Linux. First, you need to open a command prompt in your current Workspace. For Windows, you can use PowerShell and on Linux, you can use the Terminal. 
+Changing a file can be done in an editor like VS Code or Eclipse. Another approach is to use the command prompt. We show how to insert, append or replace some data in a file using the command prompt on either Windows or Linux. First, you need to open a command prompt in your current Workspace. For Windows, you can use PowerShell and on Linux, you can use the Terminal. 
 
 .Operating system
 . Windows +
@@ -16,7 +15,7 @@ We also use the command *Select-Object* to get just the required Strings from a
 <% }else if(lineNumber) {%> To insert <% if(contentPath) {%> text from the file *<%= contentFile; %>* <%}else{%> the string *<%= contentString; %>* <%}%> into the file *<%= fileName; %>* at specific line number you can execute the command `(Get-Content -Path <%= filePath; %> -TotalCount <%= lineNumber; %>) , <% if(contentPath){%>(Get-Content -Path <%= contentPath; %>)<%}else{%>"<%= contentString;%>"<% }%> ,(Get-Content -Path <%= filePath; %> |Select-Object -skip <%= lineNumber; %>) | Set-Content -Path <%= filePath; %>`
 <%}else{%>To append <%if(contentPath){ %>some data from the file *<%= contentFile; %>* <%}else{%>the string *<%= contentString; %>* <%}%>to the file *<%= fileName; %>* you can execute the command `Add-Content -Path <%= filePath; %> -Value <% if(contentPath){%>(Get-Content -Path <%= contentPath; %>)<%}else{%>"<%= contentString;%>"<% } %>`<% } %>
 
-. Linux +
+. Linux and macOS +
 For the Linux Terminal, we use the commands *cat* and *sed*. We use cat to print the text to the terminal and redirect it as input for another file. Some more information about the functionality of cat can be found https://man7.org/linux/man-pages/man1/cat.1.html[here]. The command sed is a powerful command we use to insert and replace some data in a file. Some more information about the functionality of sed can be found https://linux.die.net/man/1/sed[here]. +
 <% if(placeholder) { %>To replace *<%= placeholder; %>* in the file *<%= fileName; %>* with<% if(contentPath){%> some text from another file *<%= contentFile; %>*<%}else{%> the string *<%= contentString; %>* <% } %> you can execute the command `sed s/<%= placeholder; %>/<% if(contentPath){ %>$(cat <%= contentPath; %>)<% }else{ %><%= contentString;%><% } %>/g <%= filePath;%>`
 <% }else if(lineNumber) {%>To insert <% if(contentPath) {%> a text from the file *<%= contentFile; %>* <% }else{ %> the string *<%= contentString; %>* <% } %> into the file *<%= fileName; %>* at specific line number you can execute the command `sed "<%= lineNumber; %>i <% if(contentPath){ %>$(cat <%= contentPath; %>)<% }else{ %><%= contentString; %><% } %>" <%= filePath; %>` 

runners/wikiConsole/templates/cloneRepository.asciidoc

@@ -1,12 +1,9 @@
-Clone Repository
-================
+== Clone Repository
 
-Prerequisites
-~~~~~~~~~~~~~
+=== Prerequisites
 * You need to have Git installed. You can download Git https://git-scm.com/downloads[here] for your OS and install it by following the instructions.
 
-Download
-~~~~~~~~
+=== Download
 Open a terminal in your current workspace.
 <% if (directoryPath) { %>
 Firstly, you have to move to the directory where the repository should be cloned to.

runners/wikiConsole/templates/conclusion.asciidoc

@@ -1,4 +1,4 @@
-Conclusion
-==========
+== Conclusion
+
 
 <%= conclusion; %>

runners/wikiConsole/templates/dockerCompose.asciidoc

@@ -1,13 +1,13 @@
-Docker Compose
-=============
+== Docker Compose
 
 
-Prerequisites
-~~~~~~~~~~~~~~
+
+=== Prerequisites
+
 * You need to install https://docs.docker.com/compose/install/#install-compose[Docker Compose] on your local machine.
 
-Starting Docker Compose Application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Starting Docker Compose Application
+
 
 Docker Compose can be used via your Terminal (Linux/MacOS) or Command Line (Windows). Change the directory to the location where the `docker-compose.yml` file for your application is located:
 
@@ -22,8 +22,8 @@ If you would like to start the Docker Compose application in detached mode such
 `docker-compose up -d`
 
 <% if(port){ %>
-Startup Assertion
-~~~~~~~~~~~~~~~~~~
+=== Startup Assertion
+
 
 In order to check if your application was started successfully, you can check if it's accessible on `localhost:<%= port; %>/<%app_path%>` either from your browser or by using the `curl` or `wget` programs.
 
@@ -33,8 +33,8 @@ This command should return an `200 OK` header if the service is available.
 
 <% } %>
 
-Stopping Docker Compose Application
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Stopping Docker Compose Application
+
 
 If your application was started with the detached flag, you can stop it with the following command.
 

runners/wikiConsole/templates/downloadFile.asciidoc

@@ -1,23 +1,19 @@
-Download a file
-===============
+== Download a file
 
-Download the file in a terminal
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+=== Download the file in a terminal
 First, you need to open a command prompt in your current Workspace. For Windows, you can use Powershell and on Linux, you can use the Terminal.
 
-Prerequisites
-~~~~~~~~~~~~~
-The folder you want to load the file has to be existing. If the folder doesn't exist you can create it from terminal.
+=== Prerequisites
+* Existing folder you want to load the file. (If the folder doesn't exist you can create it from terminal.)
 
 .Operating system
 . Windows + 
-Execute the command to create a folder if not already existing `if not exists <%= dir;%> mkdir <%= dir;%>`.
-. Linux + 
+Execute the command to create a folder if not already existing `New-Item -ItemType Directory -Force -Path <%= dir; %>`.
+. Linux and macOS + 
 Execute the command `mkdir -p <%= dir;%>`. The `-p` flag won't throw an error if the target folder already exists and allows the creation of parent directories.
 
-Download
-~~~~~~~~
-
+=== Download
 Now we can start to download the file with the *wget* command. You can read some information about the usage on Linux https://manpages.ubuntu.com/manpages/hirsute/en/man1/wget.1.html[here].
 
 On Windows, we use the *Invoke-WebRequest* command but you can also use wget here. *Wget* on Windows is an alias for *Invoke-WebRequest* and mostly works like *wget* on Linux, detailed documentation can be found https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-webrequest?view=powershell-7.1[here].
@@ -28,5 +24,5 @@ On Windows, we use the *Invoke-WebRequest* command but you can also use wget her
 . Windows + 
 The Windows command to download a file is `Invoke-WebRequest <%= url;%> -O <%= dir;%>/<%= fileName;%>` with the *-OutFile* parameter we set the name of the file to *file*, and the destination where the file will be saved. 
 
-. Linux + 
+. Linux and macOS + 
 The Linux command to download a file is `wget <%= url;%> -O <%= fileName;%> -P <%= dir;%>` with the *-O* parameter we set the name of the file to *file*, and with the *-P* parameter we set the folder where the file will be saved. 

runners/wikiConsole/templates/installDevonfwIde.asciidoc

@@ -1,16 +1,16 @@
-devonfw setup
-=============
+== devonfw setup
 
 
-Prerequisites
-~~~~~~~~~~~~~~
+
+=== Prerequisites
+
 * You need to have a tool to extract `.tar.gz` files. On Windows lower Windows 10 use can use https://www.7-zip.org/7-zip[7-Zip]. The most other platforms support this feature by default.
 * You need to have https://git-scm.com/[Git] and https://curl.se/[Curl] installed. On Windows you have to install https://git-scm.com/download/win[Git for Windows]. On Linux systems you might need to install the following tools in case they are not present (`sudo apt-get install git curl` or `sudo yum install git-core curl`)
 
 Create a new directory in the location where you want to install the devonfw IDE. If you are using the terminal, navigate to this location and run `mkdir devonfw` and `cd devonfw` to create the directory and navigate into it.
 
-Download
-~~~~~~~~~
+=== Download
+
 
 <% if(version) {%>
 
@@ -36,12 +36,12 @@ On MacOS, depending on your setup, you can either use the same `wget` command sp
 
 After that you need to extract the downloaded file. To do this, run `tar -xvzf devonfw-ide-scripts.tar.gz`. Or you can simply use a tool (e.g. 7-Zip) for this.
 
-Setup
-~~~~~~
+=== Setup
+
 First, you need to prepare a settings repository to specify the tools to be installed within the devonfw IDE. Normally this is done by your project. If you just want to test the devonfw IDE, you can use the default URL, which is https://github.com/devonfw/ide-settings.
 
 For now clone the repository on https://github.com/devonfw/ide-settings or your own fork of it.
 For this tutorial you have to write `DEVON_IDE_TOOLS=(<%= tools; %>)` into the devon.properties file of the cloned settings repository. These settings will now be passed into the installation process of the devonfw IDE.
 Start the setup process by executing `.\setup 'path/to/settings'` (Windows) or `bash setup path/to/settings.git` (Linux).
 
-You can also just execute `.\setup` (Windows) or `bash setup` (Linux) and press Enter when the setup assistent asks for the URL to the settings repository. This will also download the default settings and install the default tools within the devonfw IDE.
+You can also just execute `.\setup` (Windows) or `bash setup` (Linux) and press Enter when the setup assistent asks for the URL to the settings repository. This will also download the default settings and install the default tools within the devonfw IDE.

runners/wikiConsole/templates/npmInstall.asciidoc

@@ -1,18 +1,16 @@
 <% if(npmCommand.name){ %>
-Installation of package <%= npmCommand.name; %>
-===============================================
+== Installation of package <%= npmCommand.name; %>
+
 <% } else {%>
-Install dependencies
-====================
+== Install dependencies
 <% } %>
 
-Prerequisites
-~~~~~~~~~~~~~~
+=== Prerequisites
+
 * Install Node.js. You can download Node.js https://nodejs.org/en/download/[here].
 * Installed npm. You can download npm https://www.npmjs.com/get-npm[here] and follow the installation instructions.
 
-Execution
-~~~~~~~~~
+=== Execution
 <% if(npmCommand.name){ %>
 You can install the package <%= npmCommand.name; %><% if(!npmCommand.global){ %> and add it to the dependencies<% } %>.<% } else {%>
 You need to be located in the project directory where the package.json file lies.

runners/wikiConsole/templates/runServerJava.asciidoc

@@ -1,13 +1,11 @@
-Run Java Server
-================
+== Run Java Server
 
 
-Prerequisites
-~~~~~~~~~~~~~~
+
+=== Prerequisites
 * Maven (can be included in your devonfw environment)
 
-Starting the server
-~~~~~~~~~~~~~~~~~~~
+=== Starting the server
 
 First, change the current working directory to where your server is located, i.e. `cd <%= server_path; %>`.
 
@@ -16,8 +14,7 @@ This command will start the Java server.
 
 <% if(port){ %>
 
-Startup Assertion
-~~~~~~~~~~~~~~~~~
+=== Startup Assertion
 
 You can check if the server is running correctly by checking if `localhost:<%= port; %>/<%= app_path; %>` is accessible by either using a tool like `curl`, `Postman` or simply accessing the service via your webbrowser.
 

runners/wikiVsCode/templates/changeFile.asciidoc

@@ -1,19 +1,19 @@
 == Changing of the <%= fileName; %> File
 
-=== Changing of <%= fileName; %> in the VSCode Editor
+=== Changing of <%= fileName; %> in the VS Code Editor
 
 <% if(contentPath) {%> 
 First, you want to open the file <%= contentFile; %> where you get the content from, you want to put into the <%= fileName; %>.
-Go to the file context menu in the top left corner right next to the VSCode symbol and choose *Open File...* or you can do this with the keyboard shortcut ctrl+o. 
+Go to the file context menu in the top left corner right next to the VS Code symbol and choose *Open File...* or you can do this with the keyboard shortcut ctrl+o. 
 Based on your operating system a window with the file explorer opens. You have to navigate <%= contentFile; %> and select it. Select the right folder manually or by inserting the path `<%= contentPath; %>` into the path bar, so you can jump into the right folder and select the file `<%= contentFile; %>`. 
 You confirm this with the *Open* button in the bottom right corner.
-The file will be opened in a new VSCode editor window where you can select the whole text with the keyboard shortcut ctrl+a or just select the text you want to copy and copy the text with ctrl+c.<% } %>
+The file will be opened in a new VS Code editor window where you can select the whole text with the keyboard shortcut ctrl+a or just select the text you want to copy and copy the text with ctrl+c.<% } %>
 
-To change the file <%= fileName; %>, you have to open it in VSCode. 
-Open VSCode and choose in the file context menu in the top left corner right next to the VSCode symbol *Open File...* or just use the keyboard shortcut ctrl+o. 
+To change the file <%= fileName; %>, you have to open it in VS Code. 
+Open VS Code and choose in the file context menu in the top left corner right next to the VS Code symbol *Open File...* or just use the keyboard shortcut ctrl+o. 
 Based on your operating system a window with the file explorer opens. You have to navigate to <%= fileName; %> and select it. Select the right folder manually or by inserting the path `<%= filePath; %>` into the path bar, so you can jump into the right folder and select the file `<%= fileName; %>`. 
 You confirm this with the *Open* button in the bottom right corner.
-The file will be opened in a new VSCode editor window.
+The file will be opened in a new VS Code editor window.
 
 <% if(contentString) { %>Now we can copy the content *<%= contentString; %>* with ctrl+c we want to insert into <%= fileName; %>. <% } %>
 <% if(lineNumber) { %>Inserting the content into a specific line number can be done by a left mouse click into the line *<%= lineNumber%>* and using the keyboard shortcut ctrl+v.