Skip to content

Commit ab5c1ff

Browse files
Merge pull request #317 from dixyushi/update-doc-restoreDevonfwIde
Updated restoreDevonfwIde function
2 parents f17e282 + 2202288 commit ab5c1ff

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

documentation/Functions.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,27 @@ installDevonfwIde(["java","mvn"], "2020.08.001")
5151
***
5252

5353
### restoreDevonfwIde <a name="restoreDevonfwIde"></a>
54+
It is similar to [installDevonfwIde](#installDevonfwIde) function but the difference between the two functions is that restoreDevonfwIde installs the ide through a script in the background and the Katacoda user will already have an installed version of devonfw-ide at the start of the tutorial.
5455
#### parameter
55-
1. The tools you want to install within the devonfw ide: string array
56-
2. Optional: The version of the ide to install
56+
This function consist of two parameters.
57+
58+
1. First parameter:
59+
- **Required**
60+
- **Type**- Array of String.
61+
- **Description**- The tools you want to install within the devonfw-ide. You can pass every tool that can be installed with the devonfw-ide. In this parameter, based on requirement the tools you can pass are: java, mvn, node, npm, gradle, ionic jasypt, jenkins, ng, sonar and yarn.
62+
63+
2. Second parameter:
64+
- **Optional**
65+
- **Type**- String
66+
- **Description**- Devonfw-ide version that will be installed. If this parameter is omitted, it will install the newest devonfw-ide release.
67+
5768
#### example
5869
restoreDevonfwIde(["java","mvn"], "2020.08.001")
59-
#### details
60-
In the Katacoda environment the installation of the devonfw IDE is executed in a startup script.
70+
71+
Note:
72+
1. In the Katacoda environment the installation of the devonfw-ide is executed in a startup script. Katacoda user don't have to manually execute it.
73+
74+
2. It should be used when you don't have to show the Katacoda user how to install the devonfw-ide because some other tutorials are predecessors for this tutorial and the user already knows the process.
6175

6276
***
6377

0 commit comments

Comments
 (0)