From 84e64c80747791785a7acaec2e5cbafc9e486c20 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Fri, 18 Aug 2023 11:14:52 +0200 Subject: [PATCH] [INTERNAL] Update Data Directory documentation See: https://github.com/SAP/ui5-project/pull/642 JIRA: CPOUI5FOUNDATION-715 --- docs/pages/Troubleshooting.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/pages/Troubleshooting.md b/docs/pages/Troubleshooting.md index fac38650a1..960c8e1041 100644 --- a/docs/pages/Troubleshooting.md +++ b/docs/pages/Troubleshooting.md @@ -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` \ No newline at end of file +#### 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 +```