Skip to content

Commit 1b65803

Browse files
authored
update
1 parent 18f67d2 commit 1b65803

File tree

6 files changed

+44
-48
lines changed

6 files changed

+44
-48
lines changed

docs/.vitepress/config.mjs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export default defineConfig({
107107
link: '/configuration/configuration',
108108
collapsed: true,
109109
items: [
110-
{ text: 'Settings', link: '/configuration/setup' },
110+
{ text: 'General', link: '/configuration/setup' },
111111
{ text: 'Security', link: '/configuration/security' },
112112
{ text: 'Authorization', link: '/configuration/authorization' },
113113
{ text: 'Performance', link: '/configuration/performance' },
@@ -144,13 +144,16 @@ export default defineConfig({
144144
{ text: 'Remote App Calls', link: '/addons/rfc' },
145145
{ text: 'Extensibility', link: '/advanced/extensibility' },
146146
{ text: 'Technical Background', link: '/advanced/insights/insights' , items: [
147-
{ text: 'General', link: '/advanced/insights/insights' },
148-
{ text: 'open-abap', link: '/advanced/insights/open_abap' },
147+
{ text: 'General', link: '/advanced/insights/insights' },
148+
{ text: 'open-abap', link: '/advanced/insights/open_abap' },
149149
// { text: 'CI/CD', link: '/insights/ci' },
150150
// { text: 'abaplint', link: '/insights/ci' },
151151
]
152-
} ]
152+
},
153+
154+
]
153155
},
156+
154157
{
155158
text: 'Resources',
156159
link: '/resources/resources',

docs/configuration/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
outline: [2, 4]
33
---
44

5-
# Settings
5+
# General
66

77
abap2UI5 can be run with various custom configurations. This is the call for the default setup:
88
```abap

docs/get_started/about.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
11
---
22
outline: [2, 6]
33
---
4-
# Introduction
4+
# About
55

6-
Welcome to abap2UI5 – an open-source project for developing UI5 apps purely in ABAP.
6+
Welcome to **abap2UI5** – an open-source project designed to enable UI5 app development purely in ABAP.
77

88
##### Features
9-
abap2UI5 offers a pure ABAP approach to developing UI5 apps, without the need for JavaScript, OData, or RAP. Similar to classic ABAP, where a few lines of code were enough to display input forms and tables using Selection Screens & ALVs.
9+
abap2UI5 provides a purely ABAP-based approach for developing UI5 applications, with no need for JavaScript, OData, or RAP. It recalls the simplicity of classic ABAP, where just a few lines of code could generate input forms and tables using Selection Screens and ALVs.
1010

1111
##### Evolution
12-
Launched in 2023 as a personal project, abap2UI5 began with basic selection screen functionality for ABAP Cloud and an initial blog post on SCN. Thanks to contributions from the ABAP open-source community, the project has continuously evolved. Today, abap2UI5 boasts a wide range of features and is a thriving, community-driven initiative.
12+
Launched in 2023 as a personal project, abap2UI5 initially focused on offering basic selection screen functionality for ABAP Cloud, accompanied by an introductory blog post on the SAP Community Network (SCN). With the invaluable support of the ABAP open-source community, it has grown significantly, adding a broad range of features. Today, abap2UI5 is a thriving, community-driven initiative.
1313

1414
##### Compatibility
1515
![alt text](image-15.png){ width=50% }
16-
abap2UI5 runs with both language versions `ABAP Cloud` and `Standard ABAP`. It is compatible with all ABAP releases, starting from ABAP v7.02 up to ABAP for Cloud, including systems R/3 NetWeaver, S/4 On-Premise, S/4 Private Cloud and in cloud environments BTP ABAP Environment and S/4 Public Cloud.
16+
abap2UI5 is compatible with both `ABAP Cloud` and `Standard ABAP`, supporting all ABAP releases from version 7.02 to ABAP for Cloud. It runs seamlessly on systems including R/3 NetWeaver, S/4HANA On-Premise, and S/4HANA Private Cloud, as well as cloud environments such as the BTP ABAP Environment and S/4HANA Public Cloud.
1717

1818
##### Installation
1919
![alt text](image-14.png){ width=50% }
20-
The framework consists only of classes and interfaces and can be easily installed via abapGit no additional app deployment is required. To communicate with the client, you simply create a new HTTP service.
20+
The framework consists solely of classes and interfaces, making it easy to install via abapGit, with no additional deployment required. Communication with the client is established by creating a new HTTP service.
2121

2222
##### Development
23-
UI5 apps are created by defining a new ABAP class and implementing a single method from the abap2UI5 interface. Each app is fully supported as an abapGit project, making installation across various systems straightforward.
23+
Creating UI5 applications in abap2UI5 is straightforward: define a new ABAP class and implement a single method from the abap2UI5 interface. Each app is fully supported as an abapGit project, allowing seamless installation across different systems.
2424

2525
##### Cloud Ready
26-
abap2UI5 relies solely on released APIs, making it suitable for on-stack and side-by-side extensions using the new ABAP for Cloud language version. In your app implementation, you have full freedom to use new features like CDS, ABAP SQL, and EML.
26+
abap2UI5 relies exclusively on released APIs, making it ideal for both on-stack and side-by-side extensions in the new ABAP for Cloud language version. Within your app, you’re free to utilize modern ABAP capabilities such as CDS, ABAP SQL, and EML.
2727

2828
##### Clean Core
29-
By ensuring your app only uses released APIs, your development remains "cloud-ready & upgrade-stable," adhering to clean core principles and ensuring future compatibility.
29+
By using only released APIs, abap2UI5 ensures your app is "cloud-ready and upgrade-stable," aligning with clean core principles and guaranteeing compatibility with future upgrades.
3030

3131
##### ABAP Classic
3232
The abap2UI5 framework does not use any newer ABAP syntax features. This makes it also compatible for on-premise and R/3 NetWeaver systems, enabling development in classic ABAP (Tier 3) extensions. A downported version is also available for systems below ABAP 7.50.
3333

3434
##### Architecture
35-
The abap2UI5 system footprint is kept minimal. In its base version, it includes only the essential classes and interfaces. Additional functionality can be added by installing optional addons.
35+
The abap2UI5 system footprint is kept minimal. The base version includes only essential classes and interfaces, and additional functionality can be incorporated by installing optional add-ons.
3636

3737
##### Security
38-
Since you manually create the HTTP handler for client communication, you have complete control over all external interactions, ensuring security.
38+
Since you configure the HTTP handler yourself, you retain complete control over all external communications, ensuring security.
3939

40-
##### Use in Production
41-
abap2UI5 is an implementation of an HTTP handler and can be also used like any other HTTP service in a productive environment.
40+
##### Productive Usage
41+
As an implementation of an HTTP handler, abap2UI5 can be deployed in productive environments, similar to any other HTTP service.
4242

4343
##### Support
44-
Support is provided by the community on a best-effort basis. Submit an issue or join the abap2UI5 community on Slack for help.
44+
Support for abap2UI5 is provided by the community on a best-effort basis. If you need assistance, submit an issue or join the abap2UI5 community on Slack.
4545

4646
##### Contribution
47-
Contributions are always welcome. Share your knowledge, hunt for or fix bugs, submit a pull request, expand this documentation, leave a comment, or help spread the word about abap2UI5. The project thrives on your involvement!
47+
Contributions are encouraged! Whether through bug fixes, feature additions, documentation enhancements, or community engagement, your involvement helps the project thrive. Consider submitting a pull request, sharing feedback, or helping spread the word about abap2UI5.
4848

4949
##### Sponsor
50-
abap2UI5 is maintained by dedicated developers volunteering their time. If you or your company use abap2UI5 in production but cannot contribute directly, consider supporting the project in other ways. More details can be found [here.](/resources/sponsor)
50+
abap2UI5 is maintained by dedicated developers who volunteer their time. If you or your company benefit from abap2UI5, but cannot contribute directly, please consider supporting the project in other ways. More details are available [here.](/resources/sponsor)

docs/get_started/next.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# What's Next?
22

3-
Expand your skills and explore more!
3+
Expand your skills and dive deeper into abap2UI5!
44

55
#### Development
6-
Looking to sharpen your development skills? Explore advanced guides and best practices to take your abap2UI5 projects to the next level. Start learning [here.](/development/general)
6+
Want to level up your development skills? Explore advanced guides and best practices to elevate your abap2UI5 projects. Start learning [here.](/development/general)
77

88
#### Configuration
9-
Ready to prepare abap2UI5 for production? Follow the configuration guides to ensure a smooth, optimized setup for your system. Get started [here.](/configuration/setup)
9+
Preparing abap2UI5 for production? Follow the configuration guides to ensure a smooth, optimized setup for your system. Begin [here.](/configuration/setup)
1010

1111
#### Addons
12-
Enhance your abap2UI5 apps with additional features and functionalities by installing new add-ons. Discover them [here.](/addons/addons)
12+
Enhance your abap2UI5 applications with additional features and functionalities by installing new add-ons. Discover more [here.](/addons/addons)
1313

1414
#### Apps
15-
Explore ready-to-use apps to jumpstart your projects. Find them [here.](/addons/apps)
15+
Jumpstart your projects by exploring ready-to-use apps. Find them [here.](/addons/apps)
1616

1717
#### Blogs
18-
Gain more insights by checking out the latest blog posts. Dive into the community content [here.](/resources/blogs)
18+
Stay informed with the latest insights and community content. Check out the latest blog posts [here.](/resources/blogs)

docs/get_started/quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Install the project with [abapGit.](https://abapgit.org)
1616

1717

1818
### 2. Implement HTTP Handler
19-
Create a new package and define a new class for the HTTP implementation:
19+
Create a new package and define a new class for the HTTP handler implementation:
2020

2121
::: code-group
2222

@@ -64,7 +64,7 @@ ENDCLASS.
6464
:::
6565

6666
### 3. Create HTTP Service
67-
Create a new HTTP service. Follow [this guide](https://developers.sap.com/tutorials/abap-environment-create-http-service..html) for ABAP Cloud.
67+
Create a new HTTP service for abap2UI5. For ABAP Cloud environments, follow [this guide.](https://developers.sap.com/tutorials/abap-environment-create-http-service..html)
6868

6969
![alt text](image-5.png)
7070

@@ -75,10 +75,10 @@ Create a new HTTP service. Follow [this guide](https://developers.sap.com/tutori
7575
This project communicates solely with the HTTP service you define, giving you complete control over accessibility, authentication, and other security aspects.
7676
:::
7777

78-
### 4. First Start
79-
The abap2UI5 framework and your custom HTTP handler have been successfully installed. You can now access the HTTP endpoint from your browser.
78+
### 4. Initial Launch
79+
After installing the abap2UI5 framework and configuring your HTTP handler, you can access the HTTP endpoint from a web browser:
8080
<img width="800" alt="image" src="https://github.com/user-attachments/assets/c8962298-068d-4efb-a853-c44a9b9cda56">
81-
Press check, and start the test app.
81+
Press "Check" and launch the test app. That’s it! Now you can create a new class and start developing your own abap2UI5 applications.
8282

8383

8484

docs/get_started/use_cases.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,34 @@ outline: [2, 4]
44

55
# Use Cases
66

7-
abap2UI5 can be applied to a variety of use cases, whether you're working in a fully cloud-ready environment or using classic ABAP and calling unreleased APIs.
8-
9-
Get an overview of all possibilities in [this article.](https://www.linkedin.com/pulse/use-cases-abap2ui5-overview-abap2ui5-udbde/?trackingId=6iIX%2FNk%2BCT0%2B4JorQjpRSQ%3D%3D)
7+
abap2UI5 can be applied to a variety of use cases, whether you’re working in a fully cloud-ready environment or using classic ABAP.
108

9+
Explore all possibilities in [this article.](https://www.linkedin.com/pulse/use-cases-abap2ui5-overview-abap2ui5-udbde/?trackingId=6iIX%2FNk%2BCT0%2B4JorQjpRSQ%3D%3D)
1110

1211
### On-Stack Extension
1312

1413
#### Tier 1 Extension
15-
Development that respects the "keep the core clean" principles, ensuring your apps are cloud-ready and upgrade-stable.
14+
For clean-core compliance, develop applications that adhere to "keep the core clean" principles, ensuring that your apps are both cloud-ready and upgrade-stable:
1615
![alt text](image-11.png){ width=60% }
1716

1817
#### Tier 2 Extension
19-
If certain APIs are not yet released, you can still create a cloud-ready abap2UI5 app by calling these APIs through a separate Tier 2 wrapper:
18+
If certain APIs you need are not yet released, you can still create a cloud-ready abap2UI5 app by accessing these APIs through a separate Tier 2 wrapper:
2019
![alt text](image-21.png){ width=60% }
2120

2221
#### Tier 3 Extension
23-
Classic extension — use unreleased APIs and benefit from the freedom to make extensive changes to your system.
22+
For a classic extension approach, you can utilize unreleased APIs, allowing greater freedom to customize and extend your system:
2423
![alt text](image-10.png){ width=60% }
2524

2625
### Side-by-Side Extension
2726

2827
#### Tier 1 Extension
29-
Separate the development lifecycle of your apps from your S/4 system using only remote API calls. By only using released APIs your apps are also compatible to S/4 Public Cloud.
28+
Develop applications separately from your S/4 system’s lifecycle using only remote API calls. By using only released APIs, your apps will also be compatible with S/4HANA Public Cloud:
3029
![alt text](image-22.png){ width=60% }
3130

3231
#### Tier 3 Extension
33-
Separate the development lifecycle of your apps from your S/4 system using only remote API calls.
32+
For more flexibility, develop applications with an independent lifecycle from your S/4 system, while using remote API calls:
3433
![alt text](image-23.png){ width=60% }
3534

36-
### More
37-
38-
#### Software as a Service
39-
Use the same code line across different S/4 systems.
35+
### Software as a Service
36+
With a Tier 1 side-by-side extension, you can connect the same abap2UI5 app to multiple S/4 systems. By using the same abap2UI5 code across different remote systems (and even different customers tenants), you create a SaaS scenario:
4037
![alt text](image-9.png){ width=60% }
41-
42-
#### Remote RFC
43-
Check out the RFC Connector in the addon section:
44-
![alt text](image-24.png){ width=60% }

0 commit comments

Comments
 (0)