Skip to content

Commit 0bd9af4

Browse files
committed
Improve English content across all documentation sections
Made the documentation more casual but professional throughout: - Replaced formal phrases with conversational language - Added contractions where natural (you're, it's, we'd) - Improved readability and engagement - Fixed typos and grammar issues - Maintained technical accuracy and professionalism Sections updated: - get_started/ (6 files) - configuration/ (11 files) - development/ (6 files) - advanced/ (4 files) - technical/ (1 file) - resources/ (2 files) - index.md
1 parent b75fec2 commit 0bd9af4

30 files changed

+93
-93
lines changed

docs/advanced/addons.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The abap2UI5 project focuses solely on the following core functionalities:
55
* Event handling
66
* Data exchange
77

8-
This approach makes the project easier to maintain and improve. However, if you need additional functionality, you can install addons for common features.
8+
This approach makes the project easier to maintain and improve. However, if you need additional functionality, just install addons for common features.
99

1010
#### Addons
1111
Explore the [abap2UI5-addons](https://github.com/abap2UI5-addons) to find the functionality you need. Available features include:

docs/advanced/downporting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Downporting
22

3-
abap2UI5 works out of the box with ABAP version 750. If you are using a lower release, you can install the downported version, which is compatible with R/3 NetWeaver >702.
3+
abap2UI5 works out of the box with ABAP version 750. If you're using a lower release, you can install the downported version, which is compatible with R/3 NetWeaver >702.
44

55
#### Branch
66
To install the project on an older system, use the `702` branch:

docs/advanced/fiori.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integration to Fiori Element Apps
22

3-
It is possible to extend the object page of an Fiori list report apps with an abap2UI5 app. A repository to showcase the use case can be found [here.](https://github.com/axelmohnen/ABAP2UI5_COMP_CONT)
3+
You can extend the object page of Fiori list report apps with an abap2UI5 app. A repository to showcase the use case can be found [here.](https://github.com/axelmohnen/ABAP2UI5_COMP_CONT)
44

55
<img width="747" height="387" alt="image" src="https://github.com/user-attachments/assets/c14d5732-3b8c-4fa5-83ab-6d188a4d87db" />
66

docs/advanced/rfc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RFC Connector
22

3-
The [abap2UI5 RFC Connector](https://github.com/abap2UI5-addons/rfc-connector) allows you to trigger abap2UI5 apps remotely via RFC between two ABAP systems. This is particularly useful in distributed system landscapes or when working with legacy systems that cannot directly host UI5 frontend logic.
3+
The [abap2UI5 RFC Connector](https://github.com/abap2UI5-addons/rfc-connector) lets you trigger abap2UI5 apps remotely via RFC between two ABAP systems. This is particularly useful in distributed system landscapes or when working with legacy systems that can't directly host UI5 frontend logic.
44

55
#### When to use
66
The RFC Connector enables several useful scenarios:
@@ -18,7 +18,7 @@ The system that calls the app (the frontend system) includes the UI5 library and
1818

1919
#### Installation
2020

21-
_Prerequisite: Set up a destination in SM59 that the source system can be called via RFC. abap2UI5 need to be installed in both systems._
21+
_Prerequisite: Set up a destination in SM59 so the source system can be called via RFC. abap2UI5 needs to be installed in both systems._
2222

2323
Steps:
2424
1. Install the [abap2UI5 RFC Connector](https://github.com/abap2UI5-addons/rfc-connector) via abapGit on both system

docs/configuration/authorization.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ outline: [2, 4]
33
---
44
# Authorization
55

6-
abap2UI5 offers flexible ways to manage authorization handling. It doesnt include a built-in authorization mechanism, allowing developers to create their own solutions either at the service or application level.
6+
abap2UI5 offers flexible ways to manage authorization handling. It doesn't include a built-in authorization mechanism, so you can create your own solutions either at the service or application level.
77

8-
### Service-Level
9-
One of the easiest ways to manage access to different apps is by implementing checks within the HTTP handler. This approach allows the developer to restrict access to individual apps based on the APP_START parameter, directly in the ICF service handler class.
8+
### Service-Level
9+
One of the easiest ways to manage access to different apps is by implementing checks within the HTTP handler. This approach lets you restrict access to individual apps based on the APP_START parameter, directly in the ICF service handler class.
1010

1111
##### Example: Restricting Access Based on URL Parameters
1212
In this example, we use the ICF handler class to control which apps can be accessed based on the APP_START parameter in the HTTP request. If an unauthorized app is requested, access is denied.

docs/configuration/btp.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Integrate your abap2UI5 apps into BTP Services like Build Workzone. Find all inf
1313

1414
##### Destination
1515

16-
* Name: BACKEND_ABAP2UI5
17-
* Type: HTTP
18-
* Description: abap2UI5 Destination
19-
* URL: the url above
20-
* Proxy Type: Internet
21-
* Authentication: BasicAuthentication
16+
* Name: BACKEND_ABAP2UI5
17+
* Type: HTTP
18+
* Description: abap2UI5 Destination
19+
* URL: the URL above
20+
* Proxy Type: Internet
21+
* Authentication: BasicAuthentication
2222
* User: (user)
2323
* Password: (password)
2424

docs/configuration/launchpad.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use the following parameters for target mapping in your Launchpad configuration:
2020

2121

2222
### Troubleshooting
23-
Sometimes, installation via abapGit can cause cache-related issues. Follow these steps to resolve them:
23+
Sometimes, installation via abapGit can cause cache-related issues. Here's how to resolve them:
2424

2525
#### Cache Management
2626

@@ -38,7 +38,7 @@ Sometimes, installation via abapGit can cause cache-related issues. Follow these
3838
4. Clear browser caches and hard reload
3939

4040
#### Manual Deployment
41-
If cache clearing doesn’t resolve the issue, manually upload the frontend application:
41+
If cache clearing doesn't fix the issue, manually upload the frontend application:
4242

4343
1. Download the webapp folder of the project.
4444

docs/configuration/performance.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ outline: [2, 4]
44

55
# Performance
66

7-
abap2UI5 is fast! Almost everything is processed in the backend, leveraging the ABAP stack, which performs significantly faster than client-side or browser-based processing. <br>
7+
abap2UI5 is fast! Almost everything's processed in the backend, leveraging the ABAP stack, which performs much faster than client-side or browser-based processing. <br>
88

9-
Frontend logic is kept to a minimum: no business logic is executed, and everything is passed directly to the UI5 framework, focusing solely on UI rendering. <br>
9+
Frontend logic is kept to a minimum: no business logic is executed, and everything's passed directly to the UI5 framework, focusing solely on UI rendering. <br>
1010

11-
abap2UI5 has been successfully tested with tables containing large numbers of entries and columns. So, you can confidently develop your app — performance should not be a concern.
11+
abap2UI5 has been successfully tested with tables containing large numbers of entries and columns. So, you can confidently develop your app — performance shouldn't be a concern.
1212

1313
### Suggestions
14-
If you still want to optimize your app, consider the following tips:
15-
* Only call the `client->view_display` method when necessary. Instead, prefer using `client->model_update` so that the UI5 framework only re-renders the controls that have actually changed
14+
Want to optimize your app even more? Here are a few tips:
15+
* Only call the `client->view_display` method when necessary. Instead, prefer using `client->model_update` so the UI5 framework only re-renders the controls that have actually changed
1616
* Prefer using `client->bind` and use `client->bind_edit` only when users need to make changes that are processed in the backend. Otherwise, it leads to unnecessary data transfers
1717
* Declare public attributes in your app class only for variables displayed in the frontend. This helps prevent the framework from accessing unused values
1818
* Follow standard ABAP best practices, such as reducing loops and using sorted tables, as you would in any other ABAP development project
1919

2020
### Performance Issues?
21-
If you encounter performance issues, try creating a sample and submitting a pull request to the samples repository. We would be happy to analyze it and see if we can make abap2UI5 even faster.
21+
If you encounter performance issues, try creating a sample and submitting a pull request to the samples repository. We'd be happy to analyze it and see if we can make abap2UI5 even faster.

docs/configuration/productive_usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ outline: [2, 4]
44

55
# Productive Usage
66

7-
abap2UI5 is technically just an implementation of an HTTP handler and can be used as any other HTTP service in a productive scenario.
7+
abap2UI5 is technically just an implementation of an HTTP handler and can be used like any other HTTP service in a productive scenario.
88

99
#### Preparations
1010
You can transport abap2UI5 to production just like any other ABAP development. To ensure everything works smoothly, consider the following steps:
@@ -14,11 +14,11 @@ You can transport abap2UI5 to production just like any other ABAP development. T
1414
4. Afterward, continue by transporting your custom apps.
1515

1616
#### Stable Version
17-
The project will be continuously further developed. Therefore, there is no specific "stable" version. However, adjustments to the public APIs will be kept to a minimum to avoid frequent refactoring of apps. You can use the [releases](https://github.com/abap2ui5/abap2ui5/releases/) instead of pulling the main branch and update from time to time to reduce the effort needed for refactoring.
17+
The project will be continuously further developed, so there's no specific "stable" version. However, adjustments to the public APIs will be kept to a minimum to avoid frequent refactoring of apps. You can use the [releases](https://github.com/abap2ui5/abap2ui5/releases/) instead of pulling the main branch and update from time to time to reduce the effort needed for refactoring.
1818

1919
#### Transport
2020
Install the project using abapGit into your development system. Then, use the normal transport process for deployment to production:
2121
![alt text](image-3.png){ width=80% }
2222

2323
#### Renaming
24-
If you're starting new development but already have abap2UI5 apps running in production, and you're concerned about updating to the latest release, consider installing abap2UI5 multiple times in your system using the [renaming feature](/advanced/renaming). This way, you can safely continue development without affecting your existing apps in production.
24+
If you're starting new development but already have abap2UI5 apps running in production, and you're worried about updating to the latest release, consider installing abap2UI5 multiple times in your system using the [renaming feature](/advanced/renaming). This way, you can safely continue development without affecting your existing apps in production.

docs/configuration/s4_public_cloud.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ outline: [2, 4]
33
---
44
# S/4 Public Cloud
55

6-
In S/4 Public Cloud and BTP ABAP Environment you can only access the HTTP endpoint with `S_DEVELOP` authorization, making this scenario unsuitable for productive usage. <br>
6+
In S/4 Public Cloud and BTP ABAP Environment, you can only access the HTTP endpoint with `S_DEVELOP` authorization, making this scenario unsuitable for productive usage. <br>
77

8-
Install the [abap2UI5-frontend](https://github.com/abap2UI5/frontend) project to set up abap2UI5 apps as tiles for business users including managing permissions.
8+
Install the [abap2UI5-frontend](https://github.com/abap2UI5/frontend) project to set up abap2UI5 apps as tiles for business users, including managing permissions.
99

10-
Since UI5 apps (BSPs) are not supported directly via ADT abapGit, you'll need to manually deploy the app and complete a few additional configuration steps:
10+
Since UI5 apps (BSPs) aren't supported directly via ADT abapGit, you'll need to manually deploy the app and complete a few additional configuration steps:
1111

1212
### 1. Install the HTTP Service
1313

0 commit comments

Comments
 (0)