Skip to content

Commit 17052cf

Browse files
committed
[INTERNAL] Docs: Update Benchmarking for v4
Also consistently link to ui5.sap.com SDK.
1 parent f7998e7 commit 17052cf

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/pages/Benchmarking.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The following is a walk-through on how to evaluate the performance impact of an
2222
```sh
2323
git clone [email protected]:SAP/ui5-builder.git
2424
```
25-
Make sure you check out the `main` branch, since we'll perform the baseline test first
25+
Make sure you check out the `v4` branch, since we'll perform the baseline test first
2626
1. Install npm dependencies in both directories
2727
```sh
2828
(cd ui5-cli && npm install)
@@ -45,24 +45,24 @@ The following is a walk-through on how to evaluate the performance impact of an
4545
4646
For example:
4747
```
48-
3.0.0 (from /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs)
48+
4.0.0 (from /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs)
4949
```
5050
51-
1. Prepare your test project (we choose the [openui5-sample-app](https://github.com/SAP/openui5-sample-app))
51+
2. Prepare your test project (we choose the UI5 [sample-app](https://github.com/UI5/sample-app))
5252
1. Clone the project
5353
```sh
54-
git clone [email protected]:SAP/openui5-sample-app.git
54+
git clone [email protected]:UI5/sample-app.git
5555
```
56-
1. Navigate into the project
56+
2. Navigate into the project
5757
```sh
58-
cd openui5-sample-app
58+
cd sample-app
5959
```
60-
1. Install any required npm dependencies
60+
3. Install any required npm dependencies
6161
```sh
6262
npm install
6363
```
6464
Note: We won't link UI5 CLI into this project. Instead, we'll call it directly.
65-
1. Verify that the previously installed UI5 CLI can be called with the following command:
65+
4. Verify that the previously installed UI5 CLI can be called with the following command:
6666
```sh
6767
UI5_CLI_NO_LOCAL=X node /my/home/ui5-cli-benchmark/ui5-cli/bin/ui5.cjs --version
6868
```
@@ -148,14 +148,14 @@ The following is a walk-through on how to evaluate the performance impact of an
148148
```md
149149
ui5-builder Ref | Command | Mean [s] | Min [s] | Max [s] | Relative
150150
|:---|:---|---:|---:|---:|---:|
151-
| main ([`1234567`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.439 ± 0.036 | 1.400 | 1.507 | Baseline |
151+
| v4 ([`1234567`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.439 ± 0.036 | 1.400 | 1.507 | Baseline |
152152
| feature-duck ([`9101112`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.584 ± 0.074 | 1.477 | 1.680 | **+10%** |
153153
```
154154
Rendering like this:
155155
156156
| ui5-builder Ref | Command | Mean [s] | Min [s] | Max [s] | Relative |
157157
|:---|:---|---:|---:|---:|---:|
158-
| main ([`1234567`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.439 ± 0.036 | 1.400 | 1.507 | Baseline |
158+
| v4 ([`1234567`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.439 ± 0.036 | 1.400 | 1.507 | Baseline |
159159
| feature-duck ([`9101112`](https://github.com/SAP/ui5-builder/commit/<sha>)) | `ui5 build` | 1.584 ± 0.074 | 1.477 | 1.680 | **+10%** |
160160
161161
1. You can now share these results on GitHub or wherever you might need them.

docs/updates/migrate-v4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ This might be caused by a mismatch of your project's manifest version and your U
130130

131131
UI5 CLI v4 enhances the manifest.json with information about the `supportedLocales` (also see [Builder: Generation of Supported Locales](../pages/Builder.md#generation-of-supported-locales)). In UI5 1.71 this configuration is not supported and leads to an ambiguous error message `TypeError: invalid input` and a failure to process the manifest file.
132132

133-
UI5 CLI uses the manifest's `_version` property to decide whether the `supportedLocales` can be generated. For UI5 1.71, only versions up to `1.17.0` are supported. See [UI5 Demo Kit: Descriptor for Applications, Components, and Libraries (manifest.json)](https://sdk.openui5.org/#/topic/be0cf40f61184b358b5faedaec98b2da) for a mapping per manifest version.
133+
UI5 CLI uses the manifest's `_version` property to decide whether the `supportedLocales` can be generated. For UI5 1.71, only versions up to `1.17.0` are supported. See [UI5 Demo Kit: Descriptor for Applications, Components, and Libraries (manifest.json)](https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da) for a mapping per manifest version.
134134

135135
To resolve this issue, adjust the manifest version according to the UI5 version you are using.
136136

0 commit comments

Comments
 (0)