Skip to content

Commit d4755b5

Browse files
oblomov-devoblomov-dev
authored
update
1 parent 64b9b0a commit d4755b5

File tree

9 files changed

+90
-58
lines changed

9 files changed

+90
-58
lines changed

‎docs/.vitepress/config.mjs

Lines changed: 45 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ export default defineConfig({
66
title: "abap2UI5",
77
description: "Developing Purely in ABAP",
88
themeConfig: {
9+
editLink: {
10+
pattern: 'https://github.com/abap2UI5/abap2UI5-documentation/tree/main/docs/:path',
11+
text: 'Edit this page on GitHub'
12+
},
913
search: {
1014
provider: 'local'
1115
},
@@ -20,22 +24,17 @@ export default defineConfig({
2024
sidebar: [
2125
{
2226
text: 'Get Started',
27+
link: '/get_started/introduction',
2328
collapsed: true,
2429
items: [
25-
{ text: 'Installation', link: '/get_started/quickstart' },
26-
{ text: 'Hello World', link: '/get_started/hello_world' },
27-
{ text: 'Sample Apps', link: '/get_started/configuration' },
28-
{ text: 'Configuration', collapsed: true , items: [
29-
{ text: 'Theme', link: '/get_started/configuration#theme' },
30-
{ text: 'UI5 Bootstrapping', link: '/get_started/configuration#ui5-bootstrapping' },
31-
{ text: 'CSP', link: '/get_started/configuration#Content-Security-Policy' },
32-
{ text: 'Title', link: '/get_started/configuration#title' }
33-
]},
34-
{ text: `Overview`, collapsed: true , items: [
35-
{ text: 'Connectors', link: '/get_started/configuration#theme' },
36-
{ text: 'Addons', link: '/get_started/configuration#ui5-bootstrapping' },
37-
{ text: 'Apps', link: '/get_started/configuration#Content-Security-Policy' },
30+
{ text: 'Introduction', link: '/get_started/introduction' },
31+
{ text: 'Installation', items: [
32+
{ text: 'Standard ABAP', link: '/get_started/quickstart' },
33+
{ text: 'ABAP for Cloud', link: '/get_started/quickstart2' },
3834
]},
35+
{ text: 'Hello World', link: '/get_started/hello_world' },
36+
{ text: 'Sample Apps', link: '/get_started/sample_apps' },
37+
{ text: `What's next?`, link: '/get_started/overview' }
3938
]
4039
},
4140
{
@@ -49,65 +48,73 @@ export default defineConfig({
4948
{ text: 'Localization, i18n', link: '/features/' },
5049
{ text: 'External Libraries', link: '/features/' },
5150
{ text: 'Custom Controls', link: '/features/' },
51+
{
52+
text: 'Addons', collapsed: true, items: [
53+
{ text: 'Custom Controls', link: '/markdown-examples' },
54+
{ text: 'Popups', link: '/api-examples' },
55+
{ text: 'Layout & Variants', link: '/api-examples' },
56+
]
57+
},
5258
]
5359
},
5460
{
5561
text: 'Administration',
5662
collapsed: true,
5763
items: [
64+
{ text: 'Configuration', collapsed: true , items: [
65+
{ text: 'Theme', link: '/get_started/configuration#theme' },
66+
{ text: 'UI5 Bootstrapping', link: '/get_started/configuration#ui5-bootstrapping' },
67+
{ text: 'CSP', link: '/get_started/configuration#Content-Security-Policy' },
68+
{ text: 'Title', link: '/get_started/configuration#title' }
69+
]},
5870
{ text: 'Remotely App Call', link: '/features/' },
5971
{ text: 'Downporting', link: '/features/' },
6072
{ text: 'Multiple Installations', link: '/features/' },
73+
{ text: 'Fiori Launchpad', link: '/features/' },
74+
{ text: 'BTP Workzone', link: '/features/' },
6175
{ text: 'Productive Usage', link: '/features/' },
6276
{ text: 'Performance', link: '/features/faq' },
6377
{ text: 'Security', link: '/features/faq' },
6478
{ text: 'UI5 Framework', link: '/features/faq' },
6579
{
66-
text: 'Compatibility', collapsed: true, items: [
67-
{ text: 'BTP ABAP Env.', link: '/markdown-examples' },
68-
{ text: 'S/4 Public Cloud', link: '/api-examples' },
69-
{ text: 'S/4 Private Cloud', link: '/api-examples' },
70-
{ text: 'R/3 Netweaver', link: '/api-examples' }
71-
]
72-
},
73-
{
74-
text: 'Launchpads', collapsed: true,
80+
text: 'Setup', collapsed: true,
7581
items: [
76-
{ text: 'BTP Workzone', link: '/features/faq' },
77-
{ text: 'BTP ABAP Env.', link: '/markdown-examples' },
82+
{ text: 'BTP ABAP Environment', link: '/markdown-examples' },
7883
{ text: 'S/4 Public Cloud', link: '/markdown-examples' },
79-
{ text: 'S/4 Private Cloud', link: '/markdown-examples' }
84+
{ text: 'S/4 Private Cloud', link: '/markdown-examples' },
85+
{ text: 'R/3 Netweaver', link: '/markdown-examples' }
8086
]
8187
}
8288
]
8389
},
84-
{
85-
text: 'Technical Details',
86-
collapsed: true,
87-
items: [
88-
{ text: 'Communication', link: '/features/' },
89-
{ text: 'Persistence', link: '/features/' },
90-
{ text: 'Data Binding', link: '/features/' },
91-
{ text: 'User Interface', link: '/features/faq' },
92-
]
93-
},
90+
// {
91+
// text: 'Technical Details',
92+
// collapsed: true,
93+
// items: [
94+
// { text: 'Communication', link: '/features/' },
95+
// { text: 'Persistence', link: '/features/' },
96+
// { text: 'Data Binding', link: '/features/' },
97+
// { text: 'User Interface', link: '/features/faq' },
98+
// ]
99+
// },
94100
{
95101
text: 'Resources',
96102
collapsed: true,
97103
items: [
98104
{ text: 'Release Notes', link: '/resources/release_notes' },
99105
{ text: 'Blogs', link: '/resources/blogs' },
100106
{ text: 'Contribution', link: '/resources/release_notes' },
101-
{ text: 'Links', link: '/resources/links' }
107+
{ text: 'License', link: '/resources/license' },
102108
]
103109
}
104110
],
105111
socialLinks: [
106-
{ icon: 'github', link: 'https://github.com/abap2UI5-documentation' }
112+
{ icon: 'github', link: 'https://github.com/abap2UI5' },
113+
{ icon: 'linkedin', link: 'https://www.linkedin.com/company/abap2ui5/' }
107114
]
108115
},
109116
markdown: {
110117
// Aktiviert den "On This Page"-Bereich
111-
outline: 'deep'
118+
outline: "deep"
112119
}
113120
})

‎docs/get_started/configuration.md renamed to ‎docs/administration/configuration.md

File renamed without changes.

‎docs/get_started/image-1.png

1.34 MB
Loading

‎docs/get_started/introduction.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Introduction
2+
3+
## AAA
4+
5+
## BBB
6+
7+
## CCC
8+
9+
### CCC AAA

‎docs/get_started/overview.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Overview
2+
3+
## Connectors
4+
5+
## Addons
6+
7+
## Apps
8+
9+
## More
10+
11+
Check out other projects form the ABAP Open Source Community:
12+
13+
| Repository | Description |
14+
| ------------- | ------------- |
15+
| [The Quest](https://github.com/nomssi/axage) | A wizard's adventure game based on a fork of the AXAGE game engine (ABAP teXt Adventure Game Engine) and abap2UI5. |
16+
| [Advent of Code](https://github.com/joltdx/abap-advent-2023-template) | Template for the Advent of Code 2023 in ABAP |
17+
| [Generic DDIC Searchhelp](https://github.com/axelmohnen/a2UI5-generic_search_hlp) | Generic DDIC searchhelp generator |
18+
19+
20+
_Your app is not listed her? Feel free to send a PR and extend this file!_

‎docs/get_started/quickstart.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Quickstart
1+
---
2+
outline: [2, 4]
3+
---
4+
5+
# Installation
26

37
## 1. Installation with abapGit
48

@@ -7,7 +11,7 @@ Install the project with [abapGit.](https://abapgit.org)
711

812
## 2. Set up a new HTTP service
913
Create a new HTTP Service with the following handler implementation:
10-
##### Standard ABAP 🏠
14+
### Standard ABAP
1115
```abap
1216
CLASS zcl_my_handler_onprem DEFINITION
1317
PUBLIC
@@ -28,9 +32,7 @@ CLASS zcl_my_handler_onprem IMPLEMENTATION.
2832
2933
ENDCLASS.
3034
```
31-
##### ABAP for Cloud :cloud:
32-
<details>
33-
<summary>show code...</summary>
35+
### ABAP for Cloud
3436

3537
```abap
3638
CLASS zcl_my_handler_cloud DEFINITION
@@ -52,9 +54,6 @@ CLASS zcl_my_handler_cloud IMPLEMENTATION.
5254
5355
ENDCLASS.
5456
```
55-
56-
</details>
57-
5857
## 3. Start your App
5958
Call your HTTP Service in the browser, press check and start the app:
6059
<img width="800" alt="image" src="https://github.com/user-attachments/assets/c8962298-068d-4efb-a853-c44a9b9cda56"><br>

‎docs/get_started/sample_apps.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Sample Apps
2+
3+
[The samples repository](https://github.com/abap2UI5/abap2UI5-samples) is the easiest way to learn how to develop with abap2UI5.
4+
Try out samples for various use cases, such as tables, lists, trees, and many other UI5 controls. Quickly copy & paste code snippets and accelerate your development process. Soon you will become an abap2UI5 expert ;)
5+
6+
7+
## Overview
8+
![alt text](image-1.png)

‎docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ hero:
1414
actions:
1515
- theme: brand
1616
text: Get Started
17-
link: /get_started/quickstart
17+
link: /get_started/introduction
1818
- theme: alt
1919
text: Release Notes
2020
link: /resources/release_notes

‎docs/resources/links.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1 @@
11
# Links
2-
_Your app is not listed her? Feel free to send a PR and extend this file!_
3-
4-
5-
| Repository | Description |
6-
| ------------- | ------------- |
7-
| [The Quest](https://github.com/nomssi/axage) | A wizard's adventure game based on a fork of the AXAGE game engine (ABAP teXt Adventure Game Engine) and abap2UI5. |
8-
| [Advent of Code](https://github.com/joltdx/abap-advent-2023-template) | Template for the Advent of Code 2023 in ABAP |
9-
| [Generic DDIC Searchhelp](https://github.com/axelmohnen/a2UI5-generic_search_hlp) | Generic DDIC searchhelp generator |
10-
11-
12-

0 commit comments

Comments
 (0)