Skip to content

Commit f691726

Browse files
authored
Revise content and structure in about.md
Updated the outline and improved the text for clarity and consistency throughout the document. Enhanced sections on architecture, performance, security, and community contributions.
1 parent c5179d1 commit f691726

1 file changed

Lines changed: 48 additions & 44 deletions

File tree

docs/get_started/about.md

Lines changed: 48 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
outline: [2, 4]
2+
outline: [2, 6]
33
---
44
# Introduction
55

@@ -20,94 +20,98 @@ CLASS zcl_my_app IMPLEMENTATION.
2020
ENDCLASS.
2121
```
2222

23-
That's it -- your first UI5 app is ready.
23+
That's it your first UI5 app is ready!
2424

25+
##### About
2526
Since launching in 2023, abap2UI5 has evolved from a small side project into a community-driven framework trusted by ABAP developers worldwide. The framework takes care of all the frontend complexity, letting you focus purely on business logic while leveraging your existing ABAP skills.
2627

2728
*See our [Getting Started Guide](/get_started/quickstart) for step-by-step instructions*
2829
*Browse [Sample Applications](/get_started/samples) to see abap2UI5 in action*
2930

3031
### Why abap2UI5?
3132

32-
Traditional UI5 development requires JavaScript expertise, frontend deployment, and OData service configuration. abap2UI5 removes these hurdles:
33+
Traditional UI5 development requires JavaScript expertise, frontend deployment, and OData service configuration. abap2UI5 cuts through these complexities:
3334

34-
- **Use your existing ABAP skills** -- no frontend expertise required
35-
- **Run everywhere** -- from legacy R/3 systems to modern S/4 Cloud environments
36-
- **Go beyond RAP** -- when standard Fiori Elements capabilities reach their limits, abap2UI5 gives you full control over the UI
37-
- **Iterate fast** -- prototype and refine business applications quickly
35+
- **Leverage your existing ABAP skills** – do what you know best, no frontend expertise required
36+
- **Universal compatibility** – build apps that run on legacy R/3 systems and modern S/4 Cloud environments
37+
- **Extend beyond RAP** when standard capabilities reach their limits
38+
- **Prototype rapidly** – iterate quickly on new business applications
3839

39-
Each application is packaged as an [abapGit](https://abapgit.org) project, so installation works across systems without separate frontend deployments.
40+
Each application is packaged as an [abapGit](https://abapgit.org) project, simplifying installation across systems without separate frontend deployments.
4041

4142
### Overview
43+
<br>
4244

43-
#### Architecture
44-
abap2UI5 follows a "thin frontend" approach -- all processing, logic, and data management stays in the ABAP backend. The browser handles only UI rendering. This keeps configuration simple, avoids client-side complexity, and ensures that business logic and sensitive data remain on the server.
45+
##### Architecture
46+
abap2UI5 takes a "thin frontend" approach all processing, logic, and data management stays in the backend. This design simplifies configuration, cuts down on client-side complexity (say goodbye to cache clearing hassles), and keeps business logic and sensitive data securely on the server.
4547

46-
#### Performance
47-
The frontend renders UI5 controls while the ABAP backend handles all processing. Unlike traditional UI5 apps that need separate OData calls for each view, abap2UI5 embeds data directly in XML views. This reduces network round trips and speeds up response times.
48+
##### Performance
49+
abap2UI5 delivers exceptional performance. The frontend focuses exclusively on UI rendering via the UI5 framework, while the powerful ABAP backend handles all processing. Unlike traditional UI5 apps that need separate OData calls for each view, abap2UI5 embeds data directly in XML views – dramatically reducing network round trips and speeding up response times.
4850

49-
#### Security
50-
All business logic stays in the ABAP backend. The frontend receives only the data populated in XML views -- no OData endpoints are exposed, and no raw services or database queries are accessible from outside.
51+
##### Security
52+
abap2UI5 is secure by design. All business logic stays exclusively in the ABAP backend. The frontend receives only the data populated directly in XML views. Unlike traditional UI5 apps that expose OData endpoints, abap2UI5 delivers only what users need – no access to raw services or database queries through external tools.
5153

52-
#### System Footprint
53-
The framework consists of classes and interfaces only. Additional functionality can be added through optional add-ons, keeping your system lean.
54+
##### System Footprint
55+
The framework has a minimal system footprint, it includes only classes and interfaces. Additional functionality can be added through optional addons, keeping your system lean.
5456

55-
#### Transparency
56-
All source code is publicly available on GitHub. Features and issues are discussed openly, and fixes are deployed quickly through abapGit.
57+
##### Transparency
58+
All source code is publicly available on GitHub. We discuss features and issues openly, publish technical blog posts explaining key concepts, and rapidly deploy fixes through abapGit. You'll always understand how the framework works and can verify its behavior.
5759

5860
### Compatibility
61+
<br>
5962

60-
#### ABAP Cloud
61-
abap2UI5 uses only released APIs, making it suitable for both on-stack and side-by-side extensions in ABAP for Cloud. You can take advantage of modern ABAP features like CDS, ABAP SQL, and EML within your apps.
63+
##### ABAP Cloud
64+
abap2UI5 uses only released APIs, making it perfect for both on-stack and side-by-side extensions in ABAP for Cloud. Take advantage of modern ABAP syntax features like CDS, ABAP SQL, and EML within your apps.
6265

63-
#### Clean Core
64-
By relying only on released APIs, abap2UI5 ensures your applications remain cloud-ready and upgrade-stable, aligning with SAP's clean core principles.
66+
##### Clean Core
67+
By relying only on released APIs, abap2UI5 ensures your applications remain "cloud-ready" and "upgrade-stable," aligning with SAP's clean core principles. Your investment in abap2UI5 apps is protected against future SAP system upgrades.
6568

66-
#### System Support
67-
abap2UI5 works with both ABAP Cloud and Standard ABAP, supporting all releases from version 7.02 to ABAP Cloud:
69+
##### System Support
70+
Works with both ABAP Cloud and Standard ABAP, supporting all ABAP releases from version 7.02 to ABAP Cloud:
6871
* S/4 Public Cloud and BTP ABAP Environment (ABAP for Cloud)
6972
* S/4 Private Cloud or On-Premise (ABAP for Cloud, Standard ABAP)
7073
* R/3 NetWeaver AS ABAP 7.02 or higher (Standard ABAP)
7174

72-
A downported version is available for systems running ABAP versions before 7.50.
75+
A downported version is available for systems running earlier ABAP versions (before 7.50).
7376

7477
### Enterprise Ready
7578

76-
abap2UI5 combines SAP's UI5 framework with ABAP's backend capabilities for enterprise SAP environments. It works across S/4HANA Public/Private Cloud, BTP ABAP Environment, and NetWeaver systems.
79+
abap2UI5 combines SAP's UI5 framework with ABAP's robust backend capabilities, tailored for enterprise SAP environments. The framework works seamlessly across S/4HANA Public/Private Cloud, BTP ABAP Environment, and NetWeaver systems.
7780

78-
#### Production Usage
79-
Use abap2UI5 just like any other UI5 app or ABAP program in production. Add the framework and your apps to a transport request for deployment.
81+
##### Production Usage
82+
Use abap2UI5 just like any other UI5 app or ABAP program in production. Simply add the framework and your apps to a transport request for deployment.
8083

81-
#### Licensing
82-
Technically, abap2UI5 apps are regular UI5 freestyle applications. License them the same way you handle your other UI5 apps. The framework itself is MIT licensed (free for commercial use).
84+
##### Licensing
85+
Technically, abap2UI5 apps are regular UI5 freestyle applications. License them the same way you handle your other UI5 apps in your organization. abap2UI5 itself is MIT licensed (free for commercial use).
8386

84-
#### Launchpad Integration
87+
##### Launchpad Integration
8588
Integrate your apps into:
8689
* Fiori Launchpads on S/4 On-Premise
8790
* Tiles on S/4 Public Cloud
88-
* Build Work Zone Websites on BTP
91+
* Build Workzone Websites on BTP
8992

90-
#### Installation
91-
Getting started takes three steps:
93+
##### Installation
94+
Getting started is straightforward:
9295
1. Import the project via abapGit
9396
2. Create an HTTP service for browser communication
94-
3. Start developing
97+
3. Start developing!
9598

96-
*See the [Installation Guide](/get_started/quickstart) for detailed instructions*
99+
*See our [Installation Guide](/get_started/quickstart) for detailed instructions*
97100

98101
### Community
102+
<br>
99103

100-
#### Support
101-
Support is provided by the community. Submit an issue on GitHub or join the abap2UI5 Slack channel for help.
104+
##### Support
105+
Support is provided by the community. Submit an issue on GitHub or join the abap2UI5 Slack channel for assistance.
102106

103-
*Visit the [Support page](/resources/support) for more options*
107+
*Visit our [Support page](/resources/support) for more options*
104108

105-
#### Contribution
106-
Contributions are always welcome -- whether you're fixing bugs, building new features, or improving documentation.
109+
##### Contribution
110+
Contributions are always welcome! Whether you're fixing bugs, building new features, or improving documentation, your input helps the project grow.
107111

108-
*Read the [Contribution Guide](/resources/contribution) to get involved*
112+
*Read our [Contribution Guide](/resources/contribution) to learn how to get involved*
109113

110-
#### Sponsor
114+
##### Sponsor
111115
abap2UI5 is maintained by volunteers. If you or your company benefit from the project, consider supporting it.
112116

113-
*Learn more about [Sponsorship Opportunities](/resources/sponsor)*
117+
*Learn more about [sponsorship opportunities](/resources/sponsor)*

0 commit comments

Comments
 (0)