Skip to content

Commit c8a4d15

Browse files
authored
update
1 parent 353849b commit c8a4d15

File tree

13 files changed

+165
-104
lines changed

13 files changed

+165
-104
lines changed

docs/.vitepress/cache/deps/_metadata.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
{
2-
"hash": "834f8cf3",
3-
"configHash": "710dc471",
4-
"lockfileHash": "373c3578",
5-
"browserHash": "11e0040f",
2+
"hash": "1ec9cdc8",
3+
"configHash": "5fdbd13a",
4+
"lockfileHash": "b0e705e6",
5+
"browserHash": "4fc59ccc",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "a1b784af",
10+
"fileHash": "c5a5f30b",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "fd0152ad",
16+
"fileHash": "f163a942",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "7ad229da",
22+
"fileHash": "1bb31510",
2323
"needsInterop": false
2424
},
2525
"vitepress > @vueuse/integrations/useFocusTrap": {
2626
"src": "../../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
2727
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
28-
"fileHash": "3c3076cd",
28+
"fileHash": "36ba8363",
2929
"needsInterop": false
3030
},
3131
"vitepress > mark.js/src/vanilla.js": {
3232
"src": "../../../../node_modules/mark.js/src/vanilla.js",
3333
"file": "vitepress___mark__js_src_vanilla__js.js",
34-
"fileHash": "e935d6be",
34+
"fileHash": "5f833050",
3535
"needsInterop": false
3636
},
3737
"vitepress > minisearch": {
3838
"src": "../../../../node_modules/minisearch/dist/es/index.js",
3939
"file": "vitepress___minisearch.js",
40-
"fileHash": "591a1435",
40+
"fileHash": "f5399ec6",
4141
"needsInterop": false
4242
}
4343
},

docs/.vitepress/config.mjs

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@ export default defineConfig({
5555
collapsed: true,
5656
items: [
5757
{ text: 'Introduction', link: '/get_started/introduction' },
58-
{ text: 'Quickstart', items: [
59-
{ text: 'Standard ABAP', link: '/get_started/quickstart_standard' },
60-
{ text: 'ABAP for Cloud', link: '/get_started/quickstart_cloud' },
61-
]},
58+
{ text: 'Quickstart', link: '/get_started/quickstart' },
6259
{ text: 'Hello World', link: '/get_started/hello_world' },
6360
{ text: 'Sample Apps', link: '/get_started/sample_apps' },
6461
{ text: `What's next?`, link: '/get_started/next' }
@@ -85,7 +82,6 @@ export default defineConfig({
8582
},
8683
]
8784
},
88-
8985
{
9086
text: 'Configuration',
9187
link: '/configuration/configuration',
@@ -109,8 +105,8 @@ export default defineConfig({
109105
text: 'More',
110106
items: [
111107
{ text: 'SE80 or ADT', link: '/features/faq' },
112-
{ text: 'UI5 Compatibility', link: '/features/faq' },
113-
{ text: 'ABAP Language Versions', link: '/features/faq' },
108+
{ text: 'UI5 Versions', link: '/features/faq' },
109+
{ text: 'ABAP Versions', link: '/features/faq' },
114110
]
115111
}
116112
]
@@ -140,23 +136,20 @@ export default defineConfig({
140136
text: 'Technical Insights',
141137
link: '/insights/insights',
142138
collapsed: true,
143-
items: [
144-
{ text: 'BTP Workzone', link: '/features/' },
145-
{ text: 'Remotely App Call', link: '/features/' },
146-
{ text: 'Downporting', link: '/features/' },
147-
{ text: 'Renaming', link: '/features/' },
148-
]
139+
items: [ { text: '...', link: '/insights/insights' }, ]
149140
},
150141
{
151142
text: 'Resources',
152143
link: '/resources/resources',
153144
collapsed: true,
154145
items: [
155-
{ text: 'Changelog', link: '/resources/release_notes' },
146+
{ text: 'Changelog', link: '/resources/changelog' },
156147
{ text: 'Blogs', link: '/resources/blogs' },
157-
{ text: 'Contribution', link: '/resources/release_notes' },
148+
{ text: 'References', link: '/resources/references' },
149+
{ text: 'Contribution', link: '/resources/contribution' },
150+
{ text: 'Support', link: '/resources/support' },
151+
{ text: 'Sponsor', link: '/resources/sponsor' },
158152
{ text: 'License', link: '/resources/license' },
159-
{ text: 'Support', link: '/resources/license' },
160153
]
161154
}
162155
],
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# UI5 Compatibility
2+
3+
## OpenUI5
4+
5+
## UI5
6+
7+
## OpenUI5 2.x
8+
we have to take care of the deprecated APIs:
9+
https://ui5.sap.com/#/topic/798dd9abcae24c8194922615191ab3f5
10+
https://ui5.sap.com/#/topic/2acafbfcc2cb47e8aac6d2e32399af10
11+
etc.
12+
13+
Checked abap2UI5 with the ui5-linter and made some fixes:
14+
https://github.com/SAP/ui5-linter
15+
16+
@choper725 fyi:
17+
changed the sdk check here:
18+
abap2UI5/src/01/02/z2ui5_cl_core_http_get.clas.abap
19+
20+
Line 432 in a78952d
21+
22+
` var ui5_sdk = oCurrentVersionInfo.gav.includes('com.sap.ui5') ? true : false;` && |\n| &&
23+
and changed the openById function:
24+
abap2UI5/src/01/02/z2ui5_cl_core_http_get.clas.abap
25+
26+
Line 169 in a78952d
27+
28+
` oControl = Element.getElementById(openById);` && |\n| &&
29+
Maybe check on your end if it still works? I don't have a sample for this use case and can not test it by myself. Is there a chance for a sample or any infos of how i can reproduce this case?

docs/development/development.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
11
# Development
22

3-
Dive into the hands-on process of building applications, from coding and UI design to debugging.
3+
Dive into the hands-on process of building applications, from coding and UI design to debugging.
4+
5+
6+
::: tip **Keep models *concise* and *comprehensible***
7+
8+
As said in the *["Keep it simple, stupid!"](https://en.wikipedia.org/w/index.php?title=KISS_principle&oldid=992997588)* Wikipedia entry: *"... most systems work best if they're kept simple rather than made complicated; therefore, [simplicity](https://en.wikipedia.org/wiki/Simplicity) should be a key goal in [design](https://en.wikipedia.org/wiki/Design), and unnecessary complexity should be avoided."*
9+
10+
:::
11+
12+
::: warning **Avoid overly abstract models**
13+
14+
Even though domain models should abstract from technical implementations, don't overstress this and balance it with ease of adoption. For example if the vast majority of your clients use relational databases, don't try to overly abstract from that, as that would have all suffer from common denominator syndromes.
15+
16+
:::

docs/get_started/introduction.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
# Introduction
22

3-
## AAA
43

5-
## BBB
4+
### What is abap2UI5?
65

7-
## CCC
6+
##### Compatibility
7+
8+
* BTP ABAP Environment (ABAP for Cloud)
9+
* S/4 Public Cloud (ABAP for Cloud)
10+
* S/4 Private Cloud or On-Premise (ABAP for Cloud, Standard ABAP)
11+
* R/3 NetWeaver AS ABAP 7.50 or higher (Standard ABAP)
12+
* R/3 NetWeaver AS ABAP 7.02 to 7.42: Use the [downported repositories](https://github.com/abap2UI5-downports)
13+
14+
15+
#### CCC
816

917
### CCC AAA

docs/get_started/quickstart_cloud.md renamed to docs/get_started/quickstart.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ Install the project with [abapGit.](https://abapgit.org)
1111

1212
## 2. Set up a new HTTP service
1313
Create a new HTTP Service with the following handler implementation:
14-
### Standard ABAP
15-
```abap
14+
15+
::: code-group
16+
17+
```abap [ABAP]
1618
CLASS zcl_my_handler_onprem DEFINITION
1719
PUBLIC
1820
CREATE PUBLIC.
@@ -26,15 +28,16 @@ ENDCLASS.
2628
2729
CLASS zcl_my_handler_onprem IMPLEMENTATION.
2830
29-
METHOD if_http_extension~handle_request.
31+
METHOD if_http_extension~handle_request.
32+
3033
z2ui5_cl_http_handler=>factory( server )->main( ).
34+
3135
ENDMETHOD.
3236
3337
ENDCLASS.
3438
```
35-
### ABAP for Cloud
36-
37-
```abap
39+
40+
```abap [ABAP Cloud]
3841
CLASS zcl_my_handler_cloud DEFINITION
3942
PUBLIC
4043
CREATE PUBLIC.
@@ -49,11 +52,16 @@ ENDCLASS.
4952
CLASS zcl_my_handler_cloud IMPLEMENTATION.
5053
5154
METHOD if_http_service_extension~handle_request.
52-
z2ui5_cl_http_handler=>factory_cloud( req = request res = response )->main( ).
55+
56+
z2ui5_cl_http_handler=>factory( req = request res = response )->main( ).
57+
5358
ENDMETHOD.
5459
5560
ENDCLASS.
5661
```
62+
:::
63+
64+
5765
## 3. Start your App
5866
Call your HTTP Service in the browser, press check and start the app:
5967
<img width="800" alt="image" src="https://github.com/user-attachments/assets/c8962298-068d-4efb-a853-c44a9b9cda56"><br>

docs/get_started/quickstart_standard.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Home
55

66
hero:
77
name: "abap2UI5"
8-
tagline: "Building UI5 Apps Purely in ABAP.\nEfficient. Simple. Open Source."
8+
tagline: "Developing UI5 Apps Purely in ABAP.\nEfficient. Simple. Open Source."
99
image:
1010
src: /logo.png
1111
alt: abap2UI5 Logo
@@ -17,19 +17,19 @@ hero:
1717
link: /get_started/introduction
1818
- theme: alt
1919
text: Quickstart
20-
link: /get_started/introduction
20+
link: /get_started/quickstart
2121

2222
features:
2323
- title: Guide
2424
icon: 🚀
2525
details: Learn how to develop, configure, and run apps with abap2UI5.
26-
link: /get_started/quickstart
26+
link: /get_started/introduction
2727
- title: GitHub
2828
icon: 🦖
29-
details: Jump into the code! Explore our repository, report issues, and contribute to the project.
29+
details: Jump into the code! Explore the repository, report issues, and contribute to the project.
3030
link: https://www.github.com/abap2UI5/abap2UI5
3131
- title: LinkedIn
3232
icon: ❤️
33-
details: Join us on LinkedIn to stay informed about latest updates and changes.
33+
details: Follow on LinkedIn and stay informed about latest updates and changes.
3434
link: https://www.linkedin.com/company/abap2ui5
3535
---

docs/insights/insights.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Technical Insights
22

3-
Gain a deep understanding of the internal mechanics, architecture, and technical aspects of the framework.
3+
Gain a deeper understanding of the internal mechanics, architecture, and technical aspects of the framework.
4+
5+
Work in progress... 🚧

docs/resources/contribution.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Contribution
2+
3+
This project is open source and developed alongside other projects or during free time. Contributions are greatly appreciated!
4+
5+
6+
## Contribution
7+
You can contribute in various ways:
8+
9+
extend the view with a new property (link)
10+
add a completely new control (link)
11+
add a new custom control
12+
share your demos and apps
13+
Or feel free to develop something new - every PR is welcome!
14+
15+
How to create a PR
16+
See this guidelines here.
17+
18+
Just try it out and create an issue if you run into problems!

0 commit comments

Comments
 (0)