Skip to content

Commit 06d9e11

Browse files
Merge pull request #322 from dixyushi/update-doc-addSetupScript
updated addSetupScript function
2 parents 1deb88a + ab6a065 commit 06d9e11

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

documentation/Functions.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -613,13 +613,27 @@ Note:
613613
***
614614

615615
### addSetupScript <a name="addSetupScript"></a>
616+
This function is used to add a script which is executed on startup of the tutorial.
616617
#### parameter
617-
1. Path of the script (Linux). Relative to the playbook directory
618-
2. Path of the script (Windows). Relative to the playbook directory
618+
This function consist of 2 parameters
619+
1. First parameter:
620+
- **Required**
621+
- **Type**- String
622+
- **Description**- Path of the script (Linux). Relative to the playbook directory
623+
2. Second parameter:
624+
- **Required**
625+
- **Type**- String
626+
- **Description**- Path of the script (Windows). Relative to the playbook directory
619627

620628
#### example
621629
addSetupScript("assets/createProjectScript.sh", "assets/createProjectScript.ps1")
622630

631+
Note:
632+
1. For Katacoda, only first parameter is required.
633+
634+
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.
635+
636+
623637
***
624638

625639
### openFile <a name="openFile"></a>

0 commit comments

Comments
 (0)