Skip to content

Commit 2a399b4

Browse files
authored
docs: rename further urls after migration of OpenUI5 (#515)
1 parent b40d8c3 commit 2a399b4

File tree

11 files changed

+12
-12
lines changed

11 files changed

+12
-12
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ assignees: ""
1010
This tracker is for issues caused by the tools maintained here (type definition generator and ts-interface generator for control development support).
1111
But if the bug is within the original OpenUI5/SAPUI5 code/JSDoc, then please report the issue there!
1212

13-
Example: if a UI5 API is defined wrongly in the TypeScript type definitions but the same wrong definition can also be found in the [UI5 API documentation](https://ui5.sap.com), then the issue originates probably from the JSDoc inside the UI5 code, from which both are generated, and needs to be reported in the [OpenUI5 issue tracker](https://github.com/SAP/openui5/issues/new) or the one for SAPUI5, respectively.
13+
Example: if a UI5 API is defined wrongly in the TypeScript type definitions but the same wrong definition can also be found in the [UI5 API documentation](https://ui5.sap.com), then the issue originates probably from the JSDoc inside the UI5 code, from which both are generated, and needs to be reported in the [OpenUI5 issue tracker](https://github.com/UI5/openui5/issues/new) or the one for SAPUI5, respectively.
1414

1515
**Describe the bug**
1616
A clear and concise description of what the bug is.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is managed automatically via https://cla-assistant.io/ pull request voter.
1515

1616
As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there are certain requirements that need to be reflected and adhered to when making contributions.
1717

18-
Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](https://github.com/SAP/.github/blob/main/CONTRIBUTING_USING_GENAI.md) for these requirements.
18+
Please see our [guideline for AI-generated code contributions to SAP Open Source Software Projects](https://github.com/UI5/.github/blob/main/CONTRIBUTING_USING_GENAI.md) for these requirements.
1919

2020
## Development Environment
2121

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ See the [demos](./demos) directory for consumption examples of the legacy signat
5353
## Support
5454

5555
For issues caused by the generators please open [issues](https://github.com/UI5/typescript/issues) on GitHub.<br>
56-
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/SAP/openui5/issues)/SAPUI5 ticket in this case.
56+
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/UI5/openui5/issues)/SAPUI5 ticket in this case.
5757

5858
## Contributing
5959

packages/dts-generator/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Please read the shared [mono-repo contribution](../../CONTRIBUTING.md) guide fir
66
## Issue Reporting
77

88
For problems caused by the transformation process implemented in this dts-generator, please open [issues](https://github.com/UI5/typescript/issues) in this repository on GitHub.<br>
9-
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/SAP/openui5/issues)/SAPUI5 ticket in this case.
9+
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/UI5/openui5/issues)/SAPUI5 ticket in this case.
1010

1111
## SAPUI5 Integration
1212

packages/dts-generator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ The last block which may be unexpected at first sight is for providing code comp
221221
## Support
222222

223223
For problems caused by the transformation process implemented in this dts-generator, please open [issues](https://github.com/UI5/typescript/issues) in this repository on GitHub.<br>
224-
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/SAP/openui5/issues)/SAPUI5 ticket in this case.
224+
However, issues in the UI5 type definitions which are also present in the [API documentation](https://ui5.sap.com/#/api) originate from the JSDoc comments in the original OpenUI5/SAPUI5 code, so please directly open an [OpenUI5](https://github.com/UI5/openui5/issues)/SAPUI5 ticket in this case.
225225

226226
## Contributing
227227

packages/dts-generator/docs/end-to-end-sample.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ When the build has completed, the `api.json` file is at `dist/test-resources/com
6464

6565
This file is the API description used not only for the type generation, but also for the API documentation in the UI5 SDK.
6666

67-
**NOTE:** To get proper content, you must maintain the JSDoc in the JavaScript sources correctly. This is not always trivial. You can find instructions at https://github.com/SAP/openui5/blob/master/docs/guidelines/jsdoc.md and in sibling files.
67+
**NOTE:** To get proper content, you must maintain the JSDoc in the JavaScript sources correctly. This is not always trivial. You can find instructions at https://github.com/UI5/openui5/blob/master/docs/guidelines/jsdoc.md and in sibling files.
6868

6969
The TypeScript type definitions only contain the public API of the library, so entities which are not marked as public will not be available.
7070

packages/dts-generator/src/checkDtslint/check-dtslint.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ const MIN_TYPESCRIPT_VERSION_LINES = `/**
141141
*
142142
* These *.d.ts files are generated. In case of issues, either the generator or the JSDoc in the original
143143
* OpenUI5 repository must be fixed. The generator is developed at https://github.com/UI5/typescript/tree/main/packages/dts-generator
144-
* and you can contribute to OpenUI5, see: https://github.com/SAP/openui5/blob/master/CONTRIBUTING.md
144+
* and you can contribute to OpenUI5, see: https://github.com/UI5/openui5/blob/master/CONTRIBUTING.md
145145
*/
146146
147147
/// <reference types="jquery" />

packages/dts-generator/src/checkDtslint/dtslintConfig/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"nonNpm": true,
66
"nonNpmDescription": "openui5",
77
"projects": [
8-
"https://github.com/SAP/openui5"
8+
"https://github.com/UI5/openui5"
99
],
1010
"minimumTypeScriptVersion": "5.0",
1111
"dependencies": {

packages/dts-generator/src/js-utils/ui5-metadata.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ export async function downloadDtsgenrcFiles(
199199
}
200200

201201
// GitHub libraries (example URL):
202-
// https://raw.githubusercontent.com/SAP/openui5/${version}/src/sap.m/.dtsgenrc
203-
const baseUrl = `https://raw.githubusercontent.com/SAP/openui5/${version}/src/`;
202+
// https://raw.githubusercontent.com/UI5/openui5/${version}/src/sap.m/.dtsgenrc
203+
const baseUrl = `https://raw.githubusercontent.com/UI5/openui5/${version}/src/`;
204204
const libraryNameToDtsgenrcFileUrl = zipObject(
205205
libs,
206206
map(libs, (_) => `${baseUrl}${_}/.dtsgenrc`),

packages/ts-interface-generator/src/collectClassInfo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const mSingular: { [key: string]: string | number } = {
1515

1616
function collectClassInfo(metadata: ClassInfo, className: string) {
1717
// !!!
18-
// Mostly rewritten in TypeScript based on lines 732-988 in https://github.com/SAP/openui5/blob/ff8dec90ff0591e10f8bac1754a622f5d522a957/lib/jsdoc/ui5/plugin.js#L732-L988
18+
// Mostly rewritten in TypeScript based on lines 732-988 in https://github.com/UI5/openui5/blob/ff8dec90ff0591e10f8bac1754a622f5d522a957/lib/jsdoc/ui5/plugin.js#L732-L988
1919
// hence still containing commented-out traces of that JS code.
2020
// Also, this is the reason why this code is structured and written like it is and may contain unneeded parts.
2121

0 commit comments

Comments
 (0)