update

abap2UI5 · Oct 11, 2024 · d4755b5 · d4755b5
1 parent 64b9b0a
commit d4755b5
Show file tree

Hide file tree

Showing 9 changed files with 90 additions and 58 deletions.
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs
@@ -6,6 +6,10 @@ export default defineConfig({
   title: "abap2UI5",
   description: "Developing Purely in ABAP",
   themeConfig: {
+    editLink: {
+      pattern: 'https://github.com/abap2UI5/abap2UI5-documentation/tree/main/docs/:path',
+      text: 'Edit this page on GitHub'
+    },
       search: {
         provider: 'local'
       },
@@ -20,22 +24,17 @@ export default defineConfig({
     sidebar: [
       {
         text: 'Get Started',
+        link: '/get_started/introduction',
         collapsed: true,
         items: [
-          { text: 'Installation', link: '/get_started/quickstart' },
-          { text: 'Hello World', link: '/get_started/hello_world' },
-          { text: 'Sample Apps', link: '/get_started/configuration' },
-          { text: 'Configuration', collapsed: true , items: [
-            { text: 'Theme', link: '/get_started/configuration#theme' },
-            { text: 'UI5 Bootstrapping', link: '/get_started/configuration#ui5-bootstrapping' },
-            { text: 'CSP', link: '/get_started/configuration#Content-Security-Policy' },
-            { text: 'Title', link: '/get_started/configuration#title' }
-          ]},
-          { text: `Overview`, collapsed: true , items: [
-            { text: 'Connectors', link: '/get_started/configuration#theme' },
-            { text: 'Addons', link: '/get_started/configuration#ui5-bootstrapping' },
-            { text: 'Apps', link: '/get_started/configuration#Content-Security-Policy' },
+          { text: 'Introduction', link: '/get_started/introduction' },
+          { text: 'Installation', items: [
+            { text: 'Standard ABAP', link: '/get_started/quickstart' },
+            { text: 'ABAP for Cloud', link: '/get_started/quickstart2' },
           ]},
+          { text: 'Hello World', link: '/get_started/hello_world' },
+          { text: 'Sample Apps', link: '/get_started/sample_apps' },
+          { text: `What's next?`, link: '/get_started/overview'  }
         ]
       },
       {
@@ -49,65 +48,73 @@ export default defineConfig({
           { text: 'Localization, i18n', link: '/features/' },
           { text: 'External Libraries', link: '/features/' },
           { text: 'Custom Controls', link: '/features/' },
+          {
+            text: 'Addons', collapsed: true, items: [
+              { text: 'Custom Controls', link: '/markdown-examples' },
+              { text: 'Popups', link: '/api-examples' },
+              { text: 'Layout & Variants', link: '/api-examples' },
+            ]
+          },
         ]
       },
       {
         text: 'Administration',
         collapsed: true,
         items: [
+          { text: 'Configuration', collapsed: true , items: [
+            { text: 'Theme', link: '/get_started/configuration#theme' },
+            { text: 'UI5 Bootstrapping', link: '/get_started/configuration#ui5-bootstrapping' },
+            { text: 'CSP', link: '/get_started/configuration#Content-Security-Policy' },
+            { text: 'Title', link: '/get_started/configuration#title' }
+          ]},
           { text: 'Remotely App Call', link: '/features/' },
           { text: 'Downporting', link: '/features/' },
           { text: 'Multiple Installations', link: '/features/' },
+          { text: 'Fiori Launchpad', link: '/features/' },
+          { text: 'BTP Workzone', link: '/features/' },
           { text: 'Productive Usage', link: '/features/' },
           { text: 'Performance', link: '/features/faq' },
           { text: 'Security', link: '/features/faq' },
           { text: 'UI5 Framework', link: '/features/faq' },
           {
-            text: 'Compatibility', collapsed: true, items: [
-              { text: 'BTP ABAP Env.', link: '/markdown-examples' },
-              { text: 'S/4 Public Cloud', link: '/api-examples' },
-              { text: 'S/4 Private Cloud', link: '/api-examples' },
-              { text: 'R/3 Netweaver', link: '/api-examples' }
-            ]
-          },
-          {
-            text: 'Launchpads', collapsed: true,
+            text: 'Setup', collapsed: true,
             items: [
-              { text: 'BTP Workzone', link: '/features/faq' },
-              { text: 'BTP ABAP Env.', link: '/markdown-examples' },
+              { text: 'BTP ABAP Environment', link: '/markdown-examples' },
               { text: 'S/4 Public Cloud', link: '/markdown-examples' },
-              { text: 'S/4 Private Cloud', link: '/markdown-examples' }
+              { text: 'S/4 Private Cloud', link: '/markdown-examples' },
+              { text: 'R/3 Netweaver', link: '/markdown-examples' }
             ]
           }
         ]
       },
-      {
-        text: 'Technical Details',
-        collapsed: true,
-        items: [
-          { text: 'Communication', link: '/features/' },
-          { text: 'Persistence', link: '/features/' },
-          { text: 'Data Binding', link: '/features/' },
-          { text: 'User Interface', link: '/features/faq' },
-        ]
-      },
+      // {
+      //   text: 'Technical Details',
+      //   collapsed: true,
+      //   items: [
+      //     { text: 'Communication', link: '/features/' },
+      //     { text: 'Persistence', link: '/features/' },
+      //     { text: 'Data Binding', link: '/features/' },
+      //     { text: 'User Interface', link: '/features/faq' },
+      //   ]
+      // },
       {
         text: 'Resources',
         collapsed: true,
         items: [
           { text: 'Release Notes', link: '/resources/release_notes' },
           { text: 'Blogs', link: '/resources/blogs' },
           { text: 'Contribution', link: '/resources/release_notes' },
-          { text: 'Links', link: '/resources/links' }
+          { text: 'License', link: '/resources/license' },
         ]
       }
     ],
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/abap2UI5-documentation' }
+      { icon: 'github', link: 'https://github.com/abap2UI5' },
+      { icon: 'linkedin', link: 'https://www.linkedin.com/company/abap2ui5/' }
     ]
   },
   markdown: {
     // Aktiviert den "On This Page"-Bereich
-    outline: 'deep'
+    outline: "deep"
   }
 })
diff --git a/docs/get_started/configuration.md → docs/administration/configuration.md b/docs/get_started/configuration.md → docs/administration/configuration.md
diff --git a/docs/get_started/image-1.png b/docs/get_started/image-1.png
diff --git a/docs/get_started/introduction.md b/docs/get_started/introduction.md
@@ -0,0 +1,9 @@
+# Introduction
+
+## AAA
+
+## BBB
+
+## CCC
+
+### CCC AAA
diff --git a/docs/get_started/overview.md b/docs/get_started/overview.md
@@ -0,0 +1,20 @@
+# Overview
+
+## Connectors
+
+## Addons
+
+## Apps
+
+## More
+
+Check out other projects form the ABAP Open Source Community:
+
+|  Repository | Description |
+| ------------- | ------------- |
+| [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.  |
+| [Advent of Code](https://github.com/joltdx/abap-advent-2023-template) | Template for the Advent of Code 2023 in ABAP  |
+| [Generic DDIC Searchhelp](https://github.com/axelmohnen/a2UI5-generic_search_hlp) | Generic DDIC searchhelp generator  |
+
+
+ _Your app is not listed her? Feel free to send a PR and extend this file!_
diff --git a/docs/get_started/quickstart.md b/docs/get_started/quickstart.md
@@ -1,4 +1,8 @@
-# Quickstart
+---
+outline: [2, 4]
+---
+
+# Installation
 
 ## 1. Installation with abapGit
 
@@ -7,7 +11,7 @@ Install the project with [abapGit.](https://abapgit.org)
 
 ## 2. Set up a new HTTP service
 Create a new HTTP Service with the following handler implementation:
-##### Standard ABAP  🏠
+### Standard ABAP
 ```abap
 CLASS zcl_my_handler_onprem DEFINITION
   PUBLIC
@@ -28,9 +32,7 @@ CLASS zcl_my_handler_onprem IMPLEMENTATION.
 
 ENDCLASS.
 ```
-##### ABAP for Cloud  :cloud:
-<details>
-<summary>show code...</summary>
+### ABAP for Cloud
 
 ```abap
 CLASS zcl_my_handler_cloud DEFINITION
@@ -52,9 +54,6 @@ CLASS zcl_my_handler_cloud IMPLEMENTATION.
 
 ENDCLASS.
 ```
-
-</details>
-
 ## 3. Start your App
 Call your HTTP Service in the browser, press check and start the app:
 <img width="800" alt="image" src="https://github.com/user-attachments/assets/c8962298-068d-4efb-a853-c44a9b9cda56"><br>

diff --git a/docs/get_started/sample_apps.md b/docs/get_started/sample_apps.md
@@ -0,0 +1,8 @@
+# Sample Apps
+
+[The samples repository](https://github.com/abap2UI5/abap2UI5-samples) is the easiest way to learn how to develop with abap2UI5. 
+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 ;)
+
+
+## Overview
+![alt text](image-1.png)
diff --git a/docs/index.md b/docs/index.md
@@ -14,7 +14,7 @@ hero:
   actions:
     - theme: brand   
       text: Get Started
-      link: /get_started/quickstart
+      link: /get_started/introduction
     - theme: alt    
       text: Release Notes
       link: /resources/release_notes

diff --git a/docs/resources/links.md b/docs/resources/links.md
@@ -1,12 +1 @@
 # Links
- _Your app is not listed her? Feel free to send a PR and extend this file!_
-
-
-|  Repository | Description |
-| ------------- | ------------- |
-| [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.  |
-| [Advent of Code](https://github.com/joltdx/abap-advent-2023-template) | Template for the Advent of Code 2023 in ABAP  |
-| [Generic DDIC Searchhelp](https://github.com/axelmohnen/a2UI5-generic_search_hlp) | Generic DDIC searchhelp generator  |
-
-
-