Skip to content

Commit 84e64c8

Browse files
committed
[INTERNAL] Update Data Directory documentation
See: SAP/ui5-project#642 JIRA: CPOUI5FOUNDATION-715
1 parent bc45546 commit 84e64c8

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

docs/pages/Troubleshooting.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,34 @@ UI5 + Karma:
5555

5656
### Changing UI5 Tooling's Data Directory
5757

58-
UI5 Tooling's data directory is by default at `~/.ui5`. It's the place where the framework artefacts are stored.
59-
In some cases and environments this is not a convenient location and the user needs to provide a better one. The path to it is provided via the `UI5_DATA_DIR` environment variable.
58+
UI5 Tooling's data directory is by default at `~/.ui5`. It's the place where the framework artifacts are stored.
59+
In some cases and environments this is not a convenient location and the user needs to provide a better one.
6060

61-
Example:
61+
The path to it can either be provided via environment variable or permanently set in the configuration.
6262

63-
Unix-style:
63+
!!! info
64+
Paths are resolved relative to the current root project path (i.e. where the package.json is located).
6465

65-
`UI5_DATA_DIR=/my/custom/location/ ui5 build`
66+
#### Environment variable `UI5_DATA_DIR`
6667

67-
On Windows:
68+
Unix:
69+
```sh
70+
UI5_DATA_DIR=/my/custom/location/.ui5 ui5 build
71+
```
72+
73+
Windows:
74+
```sh
75+
set UI5_DATA_DIR="C:\\my\\custom\\location\\.ui5" ui5 build
76+
```
6877

69-
`set UI5_DATA_DIR="C:\\my\\custom\\location" ui5 build`
78+
#### Configuration `ui5DataDir`
79+
80+
Configure a custom directory:
81+
```sh
82+
ui5 config set ui5DataDir /my/custom/location/.ui5
83+
```
84+
85+
Unset the configuration to switch back to the default directory:
86+
```sh
87+
ui5 config set ui5DataDir
88+
```

0 commit comments

Comments
 (0)