Skip to content

Commit f06d3e5

Browse files
authored
docs: Adjust documents to reflect the new monorepo setup (#1119)
JIRA: CPOUI5FOUNDATION-975
1 parent fa8ce98 commit f06d3e5

14 files changed

+94
-94
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
4. [💻 **Contributing Code**](#-contributing-code)
77

88
### ⚡️ Quick Links for Maintainers
9-
- [All Open Pull Requests (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+repo%3AUI5%2Fcli+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs)
10-
- [Pull Request Queue (cross-repo)](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Apr+-label%3Adependencies+-label%3ARFC+is%3Aopen+no%3Aassignee+sort%3Aupdated-desc+repo%3AUI5%2Fcli+repo%3ASAP%2Fui5-cli+repo%3ASAP%2Fui5-logger+repo%3ASAP%2Fui5-project+repo%3ASAP%2Fui5-server+repo%3ASAP%2Fui5-builder+repo%3ASAP%2Fui5-fs+repo%3ASAP%2Fgrunt-openui5+repo%3ASAP%2Fless-openui5+repo%3ASAP%2Fconnect-openui5+repo%3ASAP%2Fkarma-openui5+repo%3ASAP%2Fopenui5-sample-app)
9+
- [All Open Pull Requests](https://github.com/UI5/cli/pulls?q=is%3Aopen+is%3Apr)
10+
- [Pull Request Queue](https://github.com/UI5/cli/pulls?q=is%3Apr+-label%3Adependencies+-label%3ARFC+is%3Aopen+no%3Aassignee+sort%3Aupdated-desc)
1111

1212
## 📝 Reporting Issues
1313
### Seeking Help / Not a Bug
14-
If you need help setting something up, or if you have questions regarding UI5 CLI, please seek help on a community platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com).
14+
If you need help setting something up, or if you have questions regarding UI5 CLI, please seek help on a community platform like [StackOverflow](https://stackoverflow.com/questions/tagged/ui5-cli) or the [`#tooling`](https://openui5.slack.com/archives/C0A7QFN6B) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com).
1515

1616
### How to Report an Issue
17-
Note that we collect issues for all UI5 CLI modules (*[ui5-cli](https://github.com/SAP/ui5-cli), [ui5-server](https://github.com/SAP/ui5-server), [ui5-project](https://github.com/SAP/ui5-project), [ui5-builder](https://github.com/SAP/ui5-builder), [ui5-fs](https://github.com/SAP/ui5-fs) and [ui5-logger](https://github.com/SAP/ui5-logger)*) in the central [UI5 CLI](https://github.com/UI5/cli) repository.
17+
We collect issues for all UI5 CLI packages (*ui5-cli*, *ui5-server*, *ui5-project*, *ui5-builder*, *ui5-fs*, and *ui5-logger*) in [this](https://github.com/UI5/cli) monorepo. All packages are developed and maintained within this single mono repository.
1818

1919
1. **Only UI5 CLI issues**
2020
* Please do not report:
@@ -57,12 +57,12 @@ GitHub offers labels to categorize issues. The labels can only be set and modifi
5757
#### Specific issue categories for UI5 CLI:
5858
* **`documentation`**: This issue is about wrong documentation.
5959
* **`needs triage`**: This issue needs to be investigated and confirmed as a valid issue that is not a duplicate
60-
* **`module/ui5-builder`**: This issue is related to the UI5 Builder module
61-
* **`module/ui5-cli`**: This issue is related to the UI5 CLI module
62-
* **`module/ui5-fs`**: This issue is related to the UI5 FS module
63-
* **`module/ui5-logger`**: This issue is related to the UI5 Logger module
64-
* **`module/ui5-project`**: This issue is related to the UI5 Project module
65-
* **`module/ui5-server`**: This issue is related to the UI5 Server module
60+
* **`module/ui5-builder`**: This issue is related to the UI5 Builder package
61+
* **`module/ui5-cli`**: This issue is related to the UI5 CLI package
62+
* **`module/ui5-fs`**: This issue is related to the UI5 FS package
63+
* **`module/ui5-logger`**: This issue is related to the UI5 Logger package
64+
* **`module/ui5-project`**: This issue is related to the UI5 Project package
65+
* **`module/ui5-server`**: This issue is related to the UI5 Server package
6666

6767
##### Status of an open issue:
6868
* **`information required`**: The author is required to provide information.
@@ -89,7 +89,7 @@ For bigger features an RFC (Request for Comment) might be necessary. You should
8989
## 🔍 Analyzing Issues
9090
Analyzing issue reports can be a lot of effort. Any help is welcome! 👍
9191

92-
Open the [Bug Triage Project Board](https://github.com/orgs/SAP/projects/2) and look for open issues which require triage, additional work, or a bugfix.
92+
Open the [Issues Page](https://github.com/UI5/cli/issues) and look for open issues which require triage, additional work, or a bugfix.
9393
Especially check for issues in the **`Needs Triage`** column, or for issues with the labels **`good first issue`**, **`help wanted`**, or **`information required`**.
9494

9595
You may be able to add additional or missing information, such as a step-by-step guide on how to reproduce an issue or an analysis of the root cause. In case of the latter, you might even be able to [contribute](#-contributing-code) a bugfix. 🙌
@@ -113,11 +113,11 @@ This DCO replaces the previously used CLA ("Contributor License Agreement") as w
113113

114114
### How to Contribute
115115
1. Make sure the change is welcome (see [General Remarks](#general-remarks)).
116-
- Also check on the [UI5 CLI Task Board](https://github.com/orgs/SAP/projects/1) whether related tasks are already being worked on, blocked, or in discussion.
117-
1. Create a branch by forking the relevant module repository and apply your change.
116+
- Also check on the [UI5 CLI Issues](https://github.com/UI5/cli/issues) whether related tasks are already being worked on, blocked, or in discussion.
117+
1. Create a branch by forking this repository and apply your change.
118118
1. Commit and push your change on that branch.
119119
- 👉 **Please follow our [Development Conventions and Guidelines](docs/Guidelines.md).**
120-
1. Create a pull request in the relevant repository.
120+
1. Create a pull request in this repository.
121121
1. Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
122122
1. Wait for our code review and approval, possibly enhancing your change on request.
123123
- Note that the UI5 developers have many duties. So, depending on the required effort for reviewing, testing, and clarification, this may take a while.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@
2727
- [Contribution Guidelines](https://github.com/UI5/cli/blob/main/CONTRIBUTING.md)
2828
- [Roadmap](https://github.com/UI5/cli/issues/701)
2929

30-
## Modules
30+
## Packages
3131

32-
UI5 CLI consists of multiple modules. Each one is managed in a separate repository:
32+
UI5 CLI consists of multiple packages managed within this monorepo:
3333

34-
- [ui5-cli](https://github.com/SAP/ui5-cli): UI5 Command Line Interface, utilizing all of the following modules
35-
- [ui5-project](https://github.com/SAP/ui5-project): Modules for building a UI5 project's dependency tree, including configuration
36-
- [ui5-server](https://github.com/SAP/ui5-server): Modules for running a UI5 development server
37-
- [ui5-builder](https://github.com/SAP/ui5-builder): Modules for building UI5 projects
38-
- [ui5-fs](https://github.com/SAP/ui5-fs): UI5 specific file system abstraction
39-
- [ui5-logger](https://github.com/SAP/ui5-logger): Internal logging module
34+
- **packages/cli**: UI5 Command Line Interface, utilizing all of the following packages
35+
- **packages/project**: Modules for building a UI5 project's dependency tree, including configuration
36+
- **packages/server**: Modules for running a UI5 development server
37+
- **packages/builder**: Modules for building UI5 projects
38+
- **packages/fs**: UI5 specific file system abstraction
39+
- **packages/logger**: Internal logging module
4040

4141
**Usage Overview** *(arrows indicate dependencies)*
4242
![Module Overview](./docs/images/Module_overview.png)

docs/pages/extensibility/CustomTasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ If this callback is not provided, UI5 CLI will make an assumption as to whether
202202
* **Specification Versions before 3.0:** If no callback is provided, UI5 CLI assumes that all dependencies are required.
203203

204204

205-
*For more details, see also [RFC 0012 UI5 CLI Extension API v3](https://github.com/UI5/cli/blob/rfc-ui5-tooling-extension-api-v3/rfcs/0012-UI5-Tooling-Extension-API-3.md#3-tasks-requiring-dependencies)*
205+
*For more details, see also [RFC 0012 UI5 CLI Extension API v3](https://github.com/UI5/cli/blob/v3/rfcs/0012-UI5-Tooling-Extension-API-3.md#3-tasks-requiring-dependencies)*
206206

207207
=== "ESM"
208208

rfcs/0000-template.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
- RFC PR: -
33
- Issue: -
44
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5-
+ [ ] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [ ] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [ ] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
5+
+ [ ] [ui5-builder](./packages/builder)
6+
+ [ ] [ui5-server](./packages/server)
7+
+ [ ] [ui5-cli](./packages/cli)
8+
+ [ ] [ui5-fs](./packages/fs)
9+
+ [ ] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212

1313
# RFC 0000 Fancy Title

rfcs/0002-project-shims.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
- Start Date: 2018-04-03
22
- RFC PR: [#5](https://github.com/UI5/cli/pull/5)
33
- Issue: -
4-
- Affected components
5-
+ [ ] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [ ] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [x] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
4+
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5+
+ [ ] [ui5-builder](./packages/builder)
6+
+ [ ] [ui5-server](./packages/server)
7+
+ [ ] [ui5-cli](./packages/cli)
8+
+ [ ] [ui5-fs](./packages/fs)
9+
+ [x] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212
# RFC 0002 Project Shims
1313
## Summary

rfcs/0004-simple-build-extensibility.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
- Start Date: 2018-08-28
22
- RFC PR: [#54](https://github.com/UI5/cli/pull/54)
33
- Issue: -
4-
- Affected components
5-
+ [x] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [ ] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [x] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
4+
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5+
+ [x] [ui5-builder](./packages/builder)
6+
+ [ ] [ui5-server](./packages/server)
7+
+ [ ] [ui5-cli](./packages/cli)
8+
+ [ ] [ui5-fs](./packages/fs)
9+
+ [x] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212
# RFC 0004 Simple Build Extensibility
1313
## Summary

rfcs/0005-server-middleware-extensibility.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
- Start Date: 2019-04-23
22
- RFC PR: [#151](https://github.com/UI5/cli/pull/151)
33
- Issue: [#113](https://github.com/SAP/ui5-server/issues/113)
4-
- Affected components
5-
+ [ ] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [x] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [x] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
4+
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5+
+ [ ] [ui5-builder](./packages/builder)
6+
+ [x] [ui5-server](./packages/server)
7+
+ [ ] [ui5-cli](./packages/cli)
8+
+ [ ] [ui5-fs](./packages/fs)
9+
+ [x] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212
# RFC 0005 Server Middleware Extensibility
1313
## Summary

rfcs/0006-local-dependency-resolution.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
- Start Date: 2019-06-11
22
- RFC PR: [#157](https://github.com/UI5/cli/pull/157)
33
- Issue: -
4-
- Affected components
5-
+ [ ] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [ ] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [X] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [X] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
4+
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5+
+ [ ] [ui5-builder](./packages/builder)
6+
+ [ ] [ui5-server](./packages/server)
7+
+ [x] [ui5-cli](./packages/cli)
8+
+ [ ] [ui5-fs](./packages/fs)
9+
+ [x] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212

1313
# RFC 0006 Local Dependency Resolution

rfcs/0007-properties-file-encoding.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
- Start Date: 2019-07-15
44
- RFC PR: [#168](https://github.com/UI5/cli/pull/168)
55
- Issue: [#161](https://github.com/UI5/cli/issues/161)
6-
- Affected components
7-
- [x] [ui5-builder](https://github.com/SAP/ui5-builder)
8-
- [x] [ui5-server](https://github.com/SAP/ui5-server)
9-
- [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
10-
- [ ] [ui5-fs](https://github.com/SAP/ui5-fs)
11-
- [ ] [ui5-project](https://github.com/SAP/ui5-project)
12-
- [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
6+
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
7+
+ [x] [ui5-builder](./packages/builder)
8+
+ [x] [ui5-server](./packages/server)
9+
+ [ ] [ui5-cli](./packages/cli)
10+
+ [ ] [ui5-fs](./packages/fs)
11+
+ [ ] [ui5-project](./packages/project)
12+
+ [ ] [ui5-logger](./packages/logger)
1313

1414
## Summary
1515

rfcs/0008-resource-tagging-during-build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
- RFC PR: [#243](https://github.com/UI5/cli/pull/243)
33
- Issue: Related to https://github.com/SAP/ui5-fs/issues/155
44
- Affected components <!-- Check affected components by writing an "X" into the brackets -->
5-
+ [x] [ui5-builder](https://github.com/SAP/ui5-builder)
6-
+ [ ] [ui5-server](https://github.com/SAP/ui5-server)
7-
+ [ ] [ui5-cli](https://github.com/SAP/ui5-cli)
8-
+ [x] [ui5-fs](https://github.com/SAP/ui5-fs)
9-
+ [ ] [ui5-project](https://github.com/SAP/ui5-project)
10-
+ [ ] [ui5-logger](https://github.com/SAP/ui5-logger)
5+
+ [x] [ui5-builder](./packages/builder)
6+
+ [ ] [ui5-server](./packages/server)
7+
+ [ ] [ui5-cli](./packages/cli)
8+
+ [x] [ui5-fs](./packages/fs)
9+
+ [ ] [ui5-project](./packages/project)
10+
+ [ ] [ui5-logger](./packages/logger)
1111

1212

1313
# RFC 0008 Resource Tagging During Build

0 commit comments

Comments
 (0)