Skip to content

Commit

Permalink
[INTERNAL] Update Data Directory documentation
Browse files Browse the repository at this point in the history
See: SAP/ui5-project#642
JIRA: CPOUI5FOUNDATION-715
  • Loading branch information
matz3 committed Aug 21, 2023
1 parent bc45546 commit 84e64c8
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions docs/pages/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,34 @@ UI5 + Karma:

### Changing UI5 Tooling's Data Directory

UI5 Tooling's data directory is by default at `~/.ui5`. It's the place where the framework artefacts are stored.
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.
UI5 Tooling's data directory is by default at `~/.ui5`. It's the place where the framework artifacts are stored.
In some cases and environments this is not a convenient location and the user needs to provide a better one.

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

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

`UI5_DATA_DIR=/my/custom/location/ ui5 build`
#### Environment variable `UI5_DATA_DIR`

On Windows:
Unix:
```sh
UI5_DATA_DIR=/my/custom/location/.ui5 ui5 build
```

Windows:
```sh
set UI5_DATA_DIR="C:\\my\\custom\\location\\.ui5" ui5 build
```

`set UI5_DATA_DIR="C:\\my\\custom\\location" ui5 build`
#### Configuration `ui5DataDir`

Configure a custom directory:
```sh
ui5 config set ui5DataDir /my/custom/location/.ui5
```

Unset the configuration to switch back to the default directory:
```sh
ui5 config set ui5DataDir
```

0 comments on commit 84e64c8

Please sign in to comment.