Skip to content

Commit 00bec6c

Browse files
authored
Revise introduction and about sections in documentation
Updated the introduction and about sections for clarity and conciseness. Improved formatting and removed redundant information.
1 parent 75182ac commit 00bec6c

File tree

1 file changed

+42
-50
lines changed

1 file changed

+42
-50
lines changed

docs/get_started/about.md

Lines changed: 42 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ outline: [2, 6]
33
---
44
# Introduction
55

6-
**Developing UI5 Apps Purely in ABAP – no JavaScript, OData, or RAP required.**
6+
**Developing UI5 Apps Purely in ABAP– no JavaScript, OData, or RAP required.**
77

88
abap2UI5 is an open-source framework that brings back the simplicity of classic ABAP development to modern UI5 applications. Just as Selection Screens and ALVs could generate functional UIs with minimal code, abap2UI5 lets you create web applications with just a few lines of ABAP.
99

@@ -15,107 +15,99 @@ ENDCLASS.
1515
1616
CLASS my_app IMPLEMENTATION.
1717
METHOD z2ui5_if_app~main.
18-
client->message_box( |Hello World|) ).
18+
client->view_display( client->_z2ui5( )->page(
19+
title = 'Hello World'
20+
content = client->_z2ui5( )->button( text = 'Click Me' ) ) ).
1921
ENDMETHOD.
2022
ENDCLASS.
2123
```
2224

2325
That's it – your first UI5 app is ready!
2426

2527
##### About
26-
abap2UI5 simplifies UI5 development for both cloud and on-premise environments, bringing back the simplicity of classic ABAP development. Just as Selection Screens and ALVs could generate functional UIs with minimal code, abap2UI5 lets you create modern web applications with just a few lines of ABAP. The framework handles all frontend complexity, allowing you to focus on business logic.
28+
Since launching in 2023, abap2UI5 has evolved from a personal project into a community-driven framework trusted by ABAP developers worldwide. The framework handles all frontend complexity, allowing you to focus purely on business logic while leveraging your existing ABAP skills.
2729

28-
Since launching in 2023, abap2UI5 has evolved from a personal project into a community-driven framework trusted by ABAP developers worldwide, with active contributions, regular updates, and continuous improvements.
30+
*See our [Getting Started Guide](/get_started/quickstart) for step-by-step instructions*
31+
*Browse [Sample Applications](/get_started/samples) to see abap2UI5 in action*
2932

30-
##### Why abap2UI5?
31-
Traditional UI5 development requires JavaScript expertise, frontend deployment pipelines, and OData service configuration. abap2UI5 eliminates these complexities, letting ABAP developers leverage their existing skills to build modern UIs quickly. Whether you're modernizing legacy applications, building new business apps, or creating prototypes, abap2UI5 streamlines the development process without requiring additional frontend resources.
33+
### Why abap2UI5?
3234

33-
##### Development
34-
Creating UI5 applications with abap2UI5 is straightforward:
35-
1. Define a new ABAP class
36-
2. Implement a method from the abap2UI5 interface
37-
3. Your app is ready!
35+
Traditional UI5 development requires JavaScript expertise, frontend deployment pipelines, and OData service configuration. abap2UI5 eliminates these complexities, making it ideal for:
3836

39-
Each application is supported as an abapGit project, simplifying installation across systems without the need for extra deployment of frontend artifacts.
37+
- **Modernizing legacy applications** without rewriting business logic
38+
- **Rapid prototyping** of new business applications
39+
- **Developer productivity** when frontend resources are limited
40+
- **Proof of concepts** that can evolve into production apps
4041

41-
*See our [Getting Started Guide](/get_started/quickstart) for step-by-step instructions*
42-
*Browse [Sample Applications](/get_started/samples) to see abap2UI5 in action*
42+
Each application is packaged as an abapGit project, simplifying installation across systems without separate frontend deployments.
4343

4444
### Key Benefits
45-
<br>
4645

4746
##### Architecture
48-
abap2UI5 employs a "thin frontend" approach, with all processing, logic, and data management handled in the backend. This design simplifies configuration, minimizes client-side actions (such as clearing caches), and ensures that business logic and sensitive data remain securely on the server.
47+
abap2UI5 employs a "thin frontend" approach all processing, logic, and data management stays in the backend. This design simplifies configuration, minimizes client-side complexity (no cache clearing hassles), and ensures business logic and sensitive data remain securely on the server.
4948

5049
##### Performance
51-
abap2UI5 is impressively fast! The frontend focuses exclusively on UI rendering via the UI5 framework, while the ABAP backend handles all processing with its full power. Unlike traditional UI5 applications that require separate OData calls for each view, abap2UI5 delivers XML views with data already embedded — significantly reducing network round trips and accelerating response times.
52-
53-
##### System Footprint
54-
The abap2UI5 system footprint is kept as small as possible, including only essential classes and interfaces in the base version. Additional functionality can be added by installing optional addons.
50+
The frontend focuses exclusively on UI rendering via the UI5 framework, while the ABAP backend handles all processing. Unlike traditional UI5 applications requiring separate OData calls for each view, abap2UI5 delivers XML views with data already embedded – significantly reducing network round trips and accelerating response times.
5551

5652
##### Security
57-
abap2UI5 is exceptionally secure! All business logic remains exclusively in the ABAP backend, while the frontend receives only data populated directly in XML views. Unlike traditional UI5 applications that expose OData endpoints to clients, abap2UI5 delivers only the specific data users need — eliminating access to raw services or database queries through external tools.
58-
53+
All business logic remains exclusively in the ABAP backend. The frontend receives only data populated directly in XML views. Unlike traditional UI5 applications that expose OData endpoints, abap2UI5 delivers only the specific data users need – eliminating access to raw services or database queries through external tools.
54+
55+
##### Minimal System Footprint
56+
The base framework includes only essential classes and interfaces. Additional functionality can be added through optional addons, keeping your system lean.
57+
5958
##### Transparency
60-
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. This commitment to transparency ensures you always understand how the framework works and can verify its behavior.
59+
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 always understand how the framework works and can verify its behavior.
6160

6261
### Compatibility
63-
<br>
6462

6563
##### ABAP Cloud
66-
abap2UI5 uses only released APIs, making it suitable for both on-stack and side-by-side extensions in ABAP for Cloud. You can use modern ABAP syntax features like CDS, ABAP SQL, and EML within your apps.
64+
abap2UI5 uses only released APIs, making it suitable for both on-stack and side-by-side extensions in ABAP for Cloud. Use modern ABAP syntax features like CDS, ABAP SQL, and EML within your apps.
6765

6866
##### Clean Core
69-
By relying only on released APIs, abap2UI5 ensures that 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.
70-
71-
##### ABAP Classic
72-
The framework does not rely on newer ABAP syntax features, ensuring compatibility with on-premise and R/3 NetWeaver systems. A downported version is available for systems running ABAP versions earlier than 7.50.
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.
7368

7469
##### System Support
75-
abap2UI5 is compatible with both ABAP Cloud and Standard ABAP, supporting all ABAP releases from version 7.02 to ABAP Cloud:
70+
Compatible with both ABAP Cloud and Standard ABAP, supporting all ABAP releases from version 7.02 to ABAP Cloud:
7671
* S/4 Public Cloud and BTP ABAP Environment (ABAP for Cloud)
7772
* S/4 Private Cloud or On-Premise (ABAP for Cloud, Standard ABAP)
7873
* R/3 NetWeaver AS ABAP 7.02 or higher (Standard ABAP)
7974

80-
### Operations
81-
<br>
82-
83-
##### Installation
84-
Installing abap2UI5 is easy:
85-
1. Import the project via abapGit
86-
2. Create a new HTTP service to establish browser communication
87-
3. Start developing!
88-
89-
No additional deployment or configuration steps are needed.
75+
A downported version is available for systems running ABAP versions earlier than 7.50.
9076

91-
*See our [Installation Guide](/get_started/quickstart) for detailed instructions*
77+
### Enterprise Ready
9278

93-
##### Enterprise Ready
94-
This framework is tailored for enterprise SAP environments, combining SAP's UI5 framework with ABAP's robust backend capabilities. abap2UI5 provides an enterprise-ready way to create software compatible with a wide range of SAP products, from S/4HANA Public/Private Cloud to 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.
9580

96-
##### Productive Usage
97-
abap2UI5 can be used like any other UI5 app or ABAP program in a productive environment. Simply add the framework and your apps to a transport request to deploy them to your productive system.
81+
##### Production Usage
82+
Use abap2UI5 like any other UI5 app or ABAP program in production. Simply add the framework and your apps to a transport request for deployment.
9883

9984
##### Launchpad Integration
100-
Apps developed with abap2UI5 can be integrated into:
85+
Integrate your apps into:
10186
* Fiori Launchpads on S/4 On-Premise
10287
* Tiles on S/4 Public Cloud
10388
* Build Workzone Websites on BTP
10489

90+
##### Installation
91+
Getting started is straightforward:
92+
1. Import the project via abapGit
93+
2. Create an HTTP service for browser communication
94+
3. Start developing!
95+
96+
*See our [Installation Guide](/get_started/quickstart) for detailed instructions*
97+
10598
### Community
106-
<br>
10799

108100
##### Support
109-
Support is provided by the community. Need help? Submit an issue on GitHub or join the abap2UI5 Slack channel for assistance.
101+
Support is provided by the community. Submit an issue on GitHub or join the abap2UI5 Slack channel for assistance.
110102

111103
*Visit our [Support page](/resources/support) for more options*
112104

113105
##### Contribution
114-
Contributions are always welcome! Whether you're fixing bugs, creating new features, or improving documentation, your input helps the project grow. Check out our contribution guidelines to get started.
106+
Contributions are always welcome! Whether you're fixing bugs, creating new features, or improving documentation, your input helps the project grow.
115107

116108
*Read our [Contribution Guide](/resources/contribution) to learn how to get involved*
117109

118110
##### Sponsor
119-
abap2UI5 is maintained by volunteers. If you or your company benefit from the project but cannot contribute directly, consider supporting the project in other ways.
111+
abap2UI5 is maintained by volunteers. If you or your company benefit from the project, consider supporting it.
120112

121113
*Learn more about [sponsorship opportunities](/resources/sponsor)*

0 commit comments

Comments
 (0)