Modified content

Author: dixyushi

documentation/Functions.md

@@ -435,19 +435,15 @@ This functions consists of two parameters.
 2. 2nd Parameter:
     - **Required**
     - **Type**- JSON object
-    - **Description**- Assertion information. Only needed for the console runner to check if the server was started properly.
-#### Example: 
+    - **Description**- This parameter consist of three attributes which are the assertion information. Only needed for the console runner to check if the server was started                            properly.
+        * First attribute i.e. "startupTime" which is the time in seconds to wait before checking if the server is running
+        * Second attribute i.e. "port" which is the port number on which the server is running
+        * Third attribute i.e. "path" which is the path to the URL path on which is checked if the server is running
 runServerJava("devonfw/workspaces/main/jump-the-queue/java/jtqj/server", { "startupTime": 40, "port": 8081, "path": "jumpthequeue" })
 
-##### Assertion Information:
-startupTime = Time in seconds to wait before checking if the server is running
-port: Port on which the server is running
-path: The URL path on which is checked if the server is running
-
-If the tutorial should be tested on the console environment, you have to specify a port.
-
-##### Note: 
-For this command the devonfw-ide is not necessarily needed. Maven has to be installed. So if someone installs Maven before (e.g. with a setup script), then the command should also work.The command uses the Spring Boot Maven Plugin to run the Java application. So at the moment only Spring applications are supported.
+##### Note:
+1. If the tutorial should be tested on the console environment, you have to specify a port.
+2. For this command the devonfw-ide is not necessarily needed but Maven has to be installed. So if someone installs Maven before (e.g. with a setup script), then the command should also work.The command uses the Spring Boot Maven Plugin to run the Java application. So at the moment only Spring applications are supported.
 
 ***
 
@@ -566,18 +562,28 @@ Will build the Angular project to output directory testOutput.
 ***
 
 ### runClientNg <a name="runClientNg"></a>
-#### Parameter: 
-1. Path to the angular project from which the frontend server is to be started.
-2. Assertion information. Only needed for the console runner to check if the server was started properly.
+This function is used to start the server of Angular project.
+#### Parameters:
+This function consist of two parameters.
+1. First parameter:
+    - **Required**
+    - **Type**- String
+    - **Description**-Path to the Angular project from which the frontend server is to be started.
+2. Second parameter:
+    - **optional**
+    - **Type**- String
+    - **Description**- This parameter consist of three attributes which are the required assertion information. Only needed for the console runner to check if the server was                          started properly.
+        * First attribute i.e. "startupTime" which is the time in seconds to wait before checking if the server is running
+        * Second attribute i.e. "port" which is the port number on which the server is running
+        * Third attribute i.e. "path" which is the path to the URL path on which is checked if the server is running
 #### Example: 
 * runClientNg("jump-the-queue/angular", { "startupTime": 200, "port": 4200, "path": "" })
 
-##### Assertion Information:
-startupTime = Time in seconds to wait before checking if the server is running
-port: Port on which the server is running
-path: The URL path on which is checked if the server is running
+##### Note:
+1. If the tutorial should be tested on the console environment, you have to specify a port.
+2. To execute this, devonfw-ide must be installed and Angular project should be there.
+3. The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
 
-If the tutorial should be tested on the console environment, you have to specify a port.
 ***
 
 ### displayContent <a name="displayContent"></a>
@@ -597,9 +603,9 @@ Note: The title should never be empty and it is of type string.
     - **Required**
     - **Type**- Array of JSON objects with files, content, or images to be rendered within the Katacoda step. 
     - **Description**-This function consists of three attributes. The use for this function is to display an image and some descriptive text. No Katacoda syntax is allowed in                         the files or the content!
-        * 1st attribute i.e.  "file": Path to a file whose content is to be displayed in the Katacoda step (e.g. .asciidoc or .txt file). The file should be following the                                formating of asciidoc files. 
-        * 2nd attribute i.e. "content": Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
-        * 3rd attribute i.e. "image": Path to an image to be displayed in the Katacoda step. It should be placed under subfolder of the playbook directory. 
+        * First attribute i.e.  "file": Path to a file whose content is to be displayed in the Katacoda step (e.g. .asciidoc or .txt file). The file should be following the                                formating of asciidoc files. 
+        * Second attribute i.e. "content": Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
+        * Third attribute i.e. "image": Path to an image to be displayed in the Katacoda step. It should be placed under subfolder of the playbook directory. 
 
 #### Example: 
 * displayContent("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
@@ -629,7 +635,6 @@ This an unordered List (The empty line is necessary)
 Link:
 The tutorials repository can be found https://github.com/devonfw-tutorials/tutorials/issues[here].
 ```
-
 ##### Note:
 1. You should avoid using any command inside any text file for which you want to display content. This will cause problems with the console runner and the tests.
 
@@ -687,11 +692,11 @@ This function consist of two parameters
 1. First parameter:
     - **Required**
     - **Type**- String
-    - **Description**- Path of the script (Linux). Relative to the playbook directory
+    - **Description**- Path of the script (Linux). Relative to the playbook directory.
 2. Second parameter:
     - **Required**
     - **Type**- String
-    - **Description**- Path of the script (Windows). Relative to the playbook directory 
+    - **Description**- Path of the script (Windows). Relative to the playbook directory. 
 
 #### Example:
 * addSetupScript("assets/createProjectScript.sh", "assets/createProjectScript.ps1")
@@ -700,11 +705,16 @@ This function consist of two parameters
 1. For Katacoda, only first parameter is required.
 2. The script will run in the background while starting the tutorial. Katacoda user will have to wait till the script execution is in process. Once it is done it, Katacoda user will get the message and then command prompt will be available to Katacoda user.
 
-
 ***
 
 ### openFile <a name="openFile"></a>
-#### Parameter: 
-1. Path of the file to be opened (relative path to the workspace directory)
+This function is used to open a particular file.
+
+#### Parameter:
+This function consist of one parameter
+1. First parameter:
+    - **Required**
+    - **Type**- String
+    - **Description**- Path of the file to be opened (relative path to the workspace directory).
 #### Example: 
 * openFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java")