From 459a0bde23eba96a21cf8577cfc6dbdb922b94b2 Mon Sep 17 00:00:00 2001 From: oblomov-dev <102328295+oblomov-dev@users.noreply.github.com> Date: Sun, 13 Oct 2024 13:20:02 +0200 Subject: [PATCH 1/5] Update config.mjs --- docs/.vitepress/config.mjs | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index ac511b4..c9313e1 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -33,13 +33,17 @@ export default defineConfig({ { text: 'Resources', link: '/resources/resources' }, ]}, { text: 'Jump', items: [ - { text: 'Repositories', items: [ - { text: 'Project', link: '/item-1' }, - { text: 'Downports', link: '/item-2' }, - { text: 'Issues', link: '/item-2' }, + { text: 'GitHub', items: [ + { text: 'abap2UI5', link: 'https://github.com/abap2UI5/abap2UI5' }, + { text: 'samples', link: 'https://github.com/abap2UI5/samples' }, + { text: 'docs', link: 'https://github.com/abap2UI5/docs' }, + { text: 'addons', link: https://github.com/abap2UI5-addons' }, + { text: 'connectors', link: 'https://github.com/abap2UI5-addons' }, + { text: 'apps', link: 'https://github.com/abap2UI5-apps' }, + { text: 'downports', link: 'https://github.com/abap2UI5-downports' }, ]}, - { text: 'Connectors', items: [ - { text: 'Addons', link: '/item-1' }, + { text: 'Link', items: [ + { text: 'Issues', link: '/item-1' }, { text: 'Alln', link: '/item-2' }, { text: 'Issues', link: '/item-2' } ]}, From b2e32bf2c4ce9c33868c2e8fbb96ccc0db958ef7 Mon Sep 17 00:00:00 2001 From: oblomov-dev <102328295+oblomov-dev@users.noreply.github.com> Date: Sun, 13 Oct 2024 13:09:08 +0000 Subject: [PATCH 2/5] update --- docs/.vitepress/config.mjs | 135 +++++++++--------- docs/.vitepress/theme/style.css | 13 ++ docs/advanced/advanced.md | 2 +- docs/advanced/downporting.md | 3 + docs/advanced/extension.md | 19 +++ docs/advanced/renaming.md | 3 + docs/configuration/{basics.md => general.md} | 36 ++--- docs/configuration/productive_usage.md | 12 ++ docs/configuration/security_authorization.md | 13 ++ .../faq.md => development/general.md} | 54 +++---- docs/get_started/next.md | 9 +- docs/get_started/quickstart.md | 7 + docs/get_started/sample_apps.md | 6 +- docs/index.md | 2 +- docs/insights/general.md | 3 + docs/resources/license.md | 23 +++ 16 files changed, 204 insertions(+), 136 deletions(-) create mode 100644 docs/advanced/downporting.md create mode 100644 docs/advanced/extension.md create mode 100644 docs/advanced/renaming.md rename docs/configuration/{basics.md => general.md} (59%) create mode 100644 docs/configuration/productive_usage.md create mode 100644 docs/configuration/security_authorization.md rename docs/{advanced/faq.md => development/general.md} (52%) create mode 100644 docs/insights/general.md create mode 100644 docs/resources/license.md diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index c9313e1..c3a0015 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -2,6 +2,13 @@ import { defineConfig } from 'vitepress' // https://vitepress.dev/reference/site-config export default defineConfig({ + lastUpdated: { + text: 'Updated at', + formatOptions: { + dateStyle: 'full', + timeStyle: 'medium' + } + }, base: '/docs/', // Set your base URL here head: [ ['link', { rel: 'shortcut icon', href: '/docs/favicon.ico' }], @@ -33,30 +40,18 @@ export default defineConfig({ { text: 'Resources', link: '/resources/resources' }, ]}, { text: 'Jump', items: [ - { text: 'GitHub', items: [ + { text: 'Project', items: [ { text: 'abap2UI5', link: 'https://github.com/abap2UI5/abap2UI5' }, { text: 'samples', link: 'https://github.com/abap2UI5/samples' }, { text: 'docs', link: 'https://github.com/abap2UI5/docs' }, - { text: 'addons', link: https://github.com/abap2UI5-addons' }, - { text: 'connectors', link: 'https://github.com/abap2UI5-addons' }, + { text: 'issues', link: 'https://github.com/abap2UI5/abap2UI5/issues' }, + ]}, + { text: 'More', items: [ + { text: 'addons', link: 'https://github.com/abap2UI5-addons' }, + { text: 'connectors', link: 'https://github.com/abap2UI5-connectors' }, { text: 'apps', link: 'https://github.com/abap2UI5-apps' }, { text: 'downports', link: 'https://github.com/abap2UI5-downports' }, ]}, - { text: 'Link', items: [ - { text: 'Issues', link: '/item-1' }, - { text: 'Alln', link: '/item-2' }, - { text: 'Issues', link: '/item-2' } - ]}, - { text: 'Addons', items: [ - { text: 'Addons', link: '/item-1' }, - { text: 'Alln', link: '/item-2' }, - { text: 'Issues', link: '/item-2' }, - ]}, - { text: 'Apps', items: [ - { text: 'Addons', link: '/item-1' }, - { text: 'Alln', link: '/item-2' }, - { text: 'Issues', link: '/item-2' }, - ]}, ]}, { text: '1.134.0', items: [ { text: 'Changelog', link: '/resources/changelog' }, @@ -82,21 +77,21 @@ export default defineConfig({ link: '/development/development', collapsed: true, items: [ - { text: 'Basic Concepts' }, - { text: 'Messages, Errors', link: '/features/' }, - { text: 'Translation, 18n', link: '/features/' }, - { text: 'User Interface', link: '/features/' }, - { text: 'Data Binding', link: '/features/' }, - { text: 'Navigation', link: '/features/' }, - { text: 'Runtime Typed Data', link: '/features/' }, - { text: 'Debugging', link: '/features/' }, - { - text: 'Addons', items: [ - { text: 'Popups', link: '/api-examples' }, - { text: 'Layouts & Variants', link: '/api-examples' }, - { text: 'External Libraries', link: '/markdown-examples' }, - ] - }, + { text: 'General', link: '/development/general' }, + // { text: 'Messages, Errors', link: '/features/' }, + // { text: 'Translation, 18n', link: '/features/' }, + // { text: 'User Interface', link: '/features/' }, + // { text: 'Data Binding', link: '/features/' }, + // { text: 'Navigation', link: '/features/' }, + // { text: 'Runtime Typed Data', link: '/features/' }, + // { text: 'Debugging', link: '/features/' }, + // { + // text: 'Addons', items: [ + // { text: 'Popups', link: '/api-examples' }, + // { text: 'Layouts & Variants', link: '/api-examples' }, + // { text: 'External Libraries', link: '/markdown-examples' }, + // ] + // }, ] }, { @@ -104,28 +99,28 @@ export default defineConfig({ link: '/configuration/configuration', collapsed: true, items: [ - { text: 'General Settings' }, - { text: 'Productive Usage', link: '/features/' }, - { text: 'Performance', link: '/features/faq' }, - { text: 'Security, Authorization', link: '/features/faq' }, - { text: 'Fiori Launchpad', link: '/features/' }, - { - text: 'Installation', - items: [ - { text: 'BTP ABAP Environment', link: '/markdown-examples' }, - { text: 'S/4 Public Cloud', link: '/markdown-examples' }, - { text: 'S/4 Private Cloud', link: '/markdown-examples' }, - { text: 'R/3 Netweaver', link: '/markdown-examples' } - ] - }, - { - text: 'More', - items: [ - { text: 'SE80 or ADT', link: '/features/faq' }, - { text: 'UI5 Versions', link: '/features/faq' }, - { text: 'ABAP Versions', link: '/features/faq' }, - ] - } + { text: 'General', link: '/configuration/general' }, + // { text: 'Productive Usage', link: '/features/' }, + // { text: 'Performance', link: '/features/faq' }, + // { text: 'Security, Authorization', link: '/features/faq' }, + // { text: 'Fiori Launchpad', link: '/features/' }, + // { + // text: 'Installation', + // items: [ + // { text: 'BTP ABAP Environment', link: '/markdown-examples' }, + // { text: 'S/4 Public Cloud', link: '/markdown-examples' }, + // { text: 'S/4 Private Cloud', link: '/markdown-examples' }, + // { text: 'R/3 Netweaver', link: '/markdown-examples' } + // ] + // }, + // { + // text: 'More', + // items: [ + // { text: 'SE80 or ADT', link: '/features/faq' }, + // { text: 'UI5 Versions', link: '/features/faq' }, + // { text: 'ABAP Versions', link: '/features/faq' }, + // ] + // } ] }, { @@ -133,27 +128,27 @@ export default defineConfig({ link: '/advanced/advanced', collapsed: true, items: [ - { text: 'BTP Workzone', link: '/features/' }, - { text: 'Stateful Sessions', link: '/features/' }, - { text: 'Remotely App Call', link: '/features/' }, - { text: 'Downporting', link: '/features/' }, - { text: 'Renaming', link: '/features/' }, - { text: 'JS Transpiling', link: '/features/' }, - { - text: 'Extensibility', - items: [ - { text: 'Custom JS', link: '/features/' }, - { text: 'Custom Controls', link: '/features/' }, - { text: 'External Libraries', link: '/features/' }, - ] - }, + // { text: 'BTP Workzone', link: '/features/' }, + // { text: 'Stateful Sessions', link: '/features/' }, + // { text: 'Remotely App Call', link: '/features/' }, + { text: 'Downporting', link: '/advanced/downporting/' }, + { text: 'Renaming', link: '/advanced/renaming/' }, + // { text: 'JS Transpiling', link: '/features/' }, + // { + // text: 'Extensibility', + // items: [ + // { text: 'Custom JS', link: '/features/' }, + // { text: 'Custom Controls', link: '/features/' }, + // { text: 'External Libraries', link: '/features/' }, + // ] + // }, ] }, { text: 'Technical Insights', link: '/insights/insights', collapsed: true, - items: [ { text: '...', link: '/insights/insights' }, ] + items: [ { text: 'General', link: '/insights/general' }, ] }, { text: 'Resources', diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index e69de29..2e7a5b3 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -0,0 +1,13 @@ +:root { + --vp-home-hero-name-color: #d03c4a; /* Replace this with the color from logo.png */ + --vp-button-brand-bg: #d03c4a; /* Ändern Sie dies in die gewünschte Farbe */ + --vp-button-brand-border: #d03c4a; /* Ändern Sie dies in die gewünschte Farbe */ + --vp-button-brand-text: #ffffff; /* Ändern Sie dies in die gewünschte Textfarbe */ + --vp-button-brand-bg-hover: #a83232; /* Dunkelrot für Hover-Zustand */ + --vp-button-brand-border-hover: #a83232; /* Dunkelrot für Hover-Zustand */ +} + +.VPButton.brand[data-v-2dba8ca9]:hover { + background-color: var(--vp-button-brand-bg-hover); + border-color: var(--vp-button-brand-border-hover); +} \ No newline at end of file diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md index 5061df2..7cc1afa 100644 --- a/docs/advanced/advanced.md +++ b/docs/advanced/advanced.md @@ -1,3 +1,3 @@ # Advanced Topics -Explore specialized features and advanced use cases that help you leverage the full power of the framework for complex scenarios and custom solutions. \ No newline at end of file +Explore more features and advanced use cases that help you leverage the full power of the framework. \ No newline at end of file diff --git a/docs/advanced/downporting.md b/docs/advanced/downporting.md new file mode 100644 index 0000000..34af47f --- /dev/null +++ b/docs/advanced/downporting.md @@ -0,0 +1,3 @@ +# Downporting + +Downporting the Source Code of abap2UI5 offers the possibilty to install this project on releases lower than ABAP 7.50. Check out [this blog post](https://www.linkedin.com/pulse/running-abap2ui5-older-r3-releases-downport-compatibility-abaplint-mjkle/) for more information. \ No newline at end of file diff --git a/docs/advanced/extension.md b/docs/advanced/extension.md new file mode 100644 index 0000000..80fe2e1 --- /dev/null +++ b/docs/advanced/extension.md @@ -0,0 +1,19 @@ +# Extension + +## Custom JS +Use this for example to install additional custom controls [here:](https://github.com/abap2UI5-addons/custom-controls) +```abap + DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). + lo_server->main( VALUE #( + custom_js = z2ui5add_cl_cc_websocket=>get_js( ) + ) ). +``` + + +## Extension +#### 1. **How can i call my own custom function?** +Extend the initial HTTP Get call:
+image
+And in your application, call the function in the view definition:
+image + diff --git a/docs/advanced/renaming.md b/docs/advanced/renaming.md new file mode 100644 index 0000000..dd814cc --- /dev/null +++ b/docs/advanced/renaming.md @@ -0,0 +1,3 @@ +# Renaming + +Renaming of abap2UI5 Artifacts allows multiple installations of this project in the same system. Check out [this blog article](https://www.linkedin.com/pulse/renaming-abap-artifacts-power-abaplint-github-actions-development-kqede/) for further information and use cases. \ No newline at end of file diff --git a/docs/configuration/basics.md b/docs/configuration/general.md similarity index 59% rename from docs/configuration/basics.md rename to docs/configuration/general.md index d863808..38b942d 100644 --- a/docs/configuration/basics.md +++ b/docs/configuration/general.md @@ -1,4 +1,10 @@ -# Configuration +--- +outline: [2, 4] +--- + +# General + +### HTTP Handler abap2UI5 can be run with various custom configurations. This is the call for the default setup: ```abap @@ -10,7 +16,7 @@ abap2UI5 can be run with various custom configurations. This is the call for the ``` For custom configurations, simply create a config variable and import it to the main method: -## Theme +### Theme eg. for changing the theme the source code looks like this: ```abap METHOD if_http_extension~handle_request. @@ -23,7 +29,7 @@ eg. for changing the theme the source code looks like this: ENDMETHOD. ``` -## UI5 Bootstrapping +### UI5 Bootstrapping ```abap DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). @@ -32,27 +38,7 @@ eg. for changing the theme the source code looks like this: ) ). ``` -## Custom JS -Use this for example to install additional custom controls [here:](https://github.com/abap2UI5-addons/custom-controls) -```abap - DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). - lo_server->main( VALUE #( - custom_js = z2ui5add_cl_cc_websocket=>get_js( ) - ) ). -``` - -## Content-Security-Policy - -```abap - DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). - lo_server->main( VALUE #( - content_security_policy = ` ` - ) ). -``` - -## Title +### Title ```abap DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). @@ -61,7 +47,7 @@ Use this for example to install additional custom controls [here:](https://githu ) ). ``` -## Style / CSS +### Style / CSS ```abap DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). diff --git a/docs/configuration/productive_usage.md b/docs/configuration/productive_usage.md new file mode 100644 index 0000000..60e25ce --- /dev/null +++ b/docs/configuration/productive_usage.md @@ -0,0 +1,12 @@ +# Productive Usage + +#### **1. Can abap2UI5 used in a productive system?** +The project is technically just an implementation of an HTTP handler and can be used as any other HTTP Service also in a productive scenario. +#### **2. Are there any dependencies or preparations needed before using abap2UI5 in a productiv scenario?** +No, but it is recommended to follow these steps before using abap2UI5 apps in a productive scenario: +1. Transport the abap2UI5 HTTP service and the framework first +2. Sometimes an extra activation of the HTTP service is needed, along with an adjustment of the UI5 bootstrapping +3. Test the "hello world" app to ensure that abap2UI5 works correctly +4. Now continue with tranporting your custom apps... +#### **3. Does a stable version of abap2UI5 exist?** +The project will be continuously further developed. Therefore, there is no specific "stable" version. However, adjustments to the public APIs will be kept to a minimum to avoid frequent refactoring of apps. You can use [releases](https://github.com/abap2ui5/abap2ui5/releases/) instead of pulling the main branch and only update from time to time to reduce refactoring efforts. diff --git a/docs/configuration/security_authorization.md b/docs/configuration/security_authorization.md new file mode 100644 index 0000000..d221707 --- /dev/null +++ b/docs/configuration/security_authorization.md @@ -0,0 +1,13 @@ +# Security & Authorization + + +## Content-Security-Policy + +```abap + DATA(lo_server) = z2ui5_cl_http_handler=>factory( server ). + lo_server->main( VALUE #( + content_security_policy = ` ` + ) ). +``` \ No newline at end of file diff --git a/docs/advanced/faq.md b/docs/development/general.md similarity index 52% rename from docs/advanced/faq.md rename to docs/development/general.md index ee8e51d..a60bfbc 100644 --- a/docs/advanced/faq.md +++ b/docs/development/general.md @@ -1,27 +1,39 @@ -# FAQ +--- +outline: [2, 4] +--- +# General _Change the HTTP Handler and URL Paramters for various configuration possibilities: Theme, Bootstrapping, Conten-Security-Policy etc. Check it out [**here.**](https://github.com/abap2UI5/abap2UI5-documentation/blob/main/docs/handler_config.md)_ -## Client & UI +### Event -## **1. How to read URL parameters?** +#### client->_event( t_arg = value # ( ( ... ? +Check the documentation [here.](https://openui5.hana.ondemand.com/#/topic/b0fb4de7364f4bcbb053a99aa645affe) There are different ways for adressing the event handler ($event, $source, $params) and you can select your value for example with /mProperties/property.
+image +
+You can also call functions directly in the view as explained [here.](https://sapui5.hana.ondemand.com/#/entity/sap.m.ActionSheet/sample/sap.m.sample.ActionSheet/code/view/ActionSheet.fragment.xml)
+image +
+ + +#### **URL Parameters** Use the following snippet: ```abap DATA(lv_search) = client->get( )-s_config-search. DATA(lv_param) = z2ui5_cl_xml_view=>factory( client )->hlp_get_url_param( `myparam` ). ``` -## **2. How to format numbers, times and dates?** +#### **Format numbers, times & dates** Take a look at the following example:
https://github.com/abap2UI5/demo-demos/blob/main/src/z2ui5_cl_app_demo_47.clas.abap image -## **3. How to format the output of currencies?** +#### **Format Currencies** Take a look at the following example:
https://github.com/abap2UI5/demo-demos/blob/main/src/z2ui5_cl_app_demo_67.clas.abap image -## **4. How to call an url in a new tab?** +#### **Open new tab** Use the following snippet: ```abap client->timer_set( @@ -29,32 +41,8 @@ client->timer_set( event_finished = client->_event_client( action = client->cs_event-open_new_tab t_arg = value #( ( `https://www.github.com/abap2UI5` ) ) ) ). ``` -#### 5. **Which values can be send back via client->_event( t_arg = value # ( ( ... ?** -Check the documentation [here.](https://openui5.hana.ondemand.com/#/topic/b0fb4de7364f4bcbb053a99aa645affe) There are different ways for adressing the event handler ($event, $source, $params) and you can select your value for example with /mProperties/property.
-image -
-You can also call functions directly in the view as explained [here.](https://sapui5.hana.ondemand.com/#/entity/sap.m.ActionSheet/sample/sap.m.sample.ActionSheet/code/view/ActionSheet.fragment.xml)
-image -
-#### 5. **How can I change the logon language?** + +#### Logon Language Set the url parameter sap-language for this and check all other options [here.](https://help.sap.com/doc/saphelp_nw75/7.5.5/de-DE/8b/46468c433b40c3b87b2e07f34dea1b/content.htm?no_cache=true) -## Extension -#### 1. **How can i call my own custom function?** -Extend the initial HTTP Get call:
-image
-And in your application, call the function in the view definition:
-image - - -## Productive Usage -#### **1. Can abap2UI5 used in a productive system?** -The project is technically just an implementation of an HTTP handler and can be used as any other HTTP Service also in a productive scenario. -#### **2. Are there any dependencies or preparations needed before using abap2UI5 in a productiv scenario?** -No, but it is recommended to follow these steps before using abap2UI5 apps in a productive scenario: -1. Transport the abap2UI5 HTTP service and the framework first -2. Sometimes an extra activation of the HTTP service is needed, along with an adjustment of the UI5 bootstrapping -3. Test the "hello world" app to ensure that abap2UI5 works correctly -4. Now continue with tranporting your custom apps... -#### **3. Does a stable version of abap2UI5 exist?** -The project will be continuously further developed. Therefore, there is no specific "stable" version. However, adjustments to the public APIs will be kept to a minimum to avoid frequent refactoring of apps. You can use [releases](https://github.com/abap2ui5/abap2ui5/releases/) instead of pulling the main branch and only update from time to time to reduce refactoring efforts. + diff --git a/docs/get_started/next.md b/docs/get_started/next.md index 6c51299..5f1b12c 100644 --- a/docs/get_started/next.md +++ b/docs/get_started/next.md @@ -1,19 +1,18 @@ # Overview -Next check out the Development Category to learn more functionalitis. +Next check out the [Development Category](/development/development) to learn more or jump directly to: ### Addons - +Spruce up your apps 💅
https://github.com/abap2UI5-addons ### Connectors -You want to fully integrate your abap2UI5 apps in your systeem landscape? Check out the setup categroy. Or go directly to the following reposiories: +ABAP apps everywhere 🪐
https://github.com/abap2UI5-connectors ### Apps - +Put ABAP to work 🚜
https://github.com/abap2UI5-apps -Check out other projects form the ABAP Open Source Community: diff --git a/docs/get_started/quickstart.md b/docs/get_started/quickstart.md index dc10504..47abd69 100644 --- a/docs/get_started/quickstart.md +++ b/docs/get_started/quickstart.md @@ -67,3 +67,10 @@ Call your HTTP Service in the browser, press check and start the app: image
image + +::: warning Security + +The project does not connect to external systems. It communicates solely with the HTTP handler that you define. You are in complete control—decide who can access this handler and establish custom authentication methods. As your needs evolve, you can further refine the handler as you can see [here.](/configuration/general) + +::: + diff --git a/docs/get_started/sample_apps.md b/docs/get_started/sample_apps.md index 5a8b4e6..083c3f4 100644 --- a/docs/get_started/sample_apps.md +++ b/docs/get_started/sample_apps.md @@ -14,4 +14,8 @@ With over 200 samples available, you can dive right in and start experimenting: Don’t forget to press Ctrl+F12 for an in-depth look: ![alt text](image-2.png) -Check out the source code for every sample, and soon you’ll be an abap2UI5 expert! 😉 \ No newline at end of file +Check out the source code for every sample, and soon you’ll be an abap2UI5 expert! 😉 + +### Live Demo + +No system available? You can also run the samples directly in your browser [here.](https://abap2ui5.github.io/web-abap2ui5-samples/) \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index baf0d3d..d39431b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ features: details: Jump into the code! Explore the repository, report issues, and contribute to the project. link: https://www.github.com/abap2UI5/abap2UI5 - title: LinkedIn - icon: ❤️ + icon: linkedin details: Follow on LinkedIn and stay informed about latest updates and changes. link: https://www.linkedin.com/company/abap2ui5 --- \ No newline at end of file diff --git a/docs/insights/general.md b/docs/insights/general.md new file mode 100644 index 0000000..56de422 --- /dev/null +++ b/docs/insights/general.md @@ -0,0 +1,3 @@ +# General + +Check out [this blog article](https://community.sap.com/t5/technology-blogs-by-members/abap2ui5-7-technical-background-under-the-hood-of-abap2ui5/ba-p/13566459) to get an understanding of the inner workings of abap2UI5. \ No newline at end of file diff --git a/docs/resources/license.md b/docs/resources/license.md new file mode 100644 index 0000000..9e62b0e --- /dev/null +++ b/docs/resources/license.md @@ -0,0 +1,23 @@ +# License + +MIT License + +Copyright (c) 2024 abap2UI5 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file From 469864ba3bc8c6288754c03057db8f6fc0c8452c Mon Sep 17 00:00:00 2001 From: oblomov-dev <102328295+oblomov-dev@users.noreply.github.com> Date: Sun, 13 Oct 2024 13:16:08 +0000 Subject: [PATCH 3/5] update --- docs/.vitepress/config.mjs | 2 ++ docs/index.md | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index c3a0015..08b7b31 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -13,6 +13,8 @@ export default defineConfig({ head: [ ['link', { rel: 'shortcut icon', href: '/docs/favicon.ico' }], ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/docs/favicon.ico' }], + ['link', { rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css' }], + ], title: "abap2UI5", description: "Developing Purely in ABAP", diff --git a/docs/index.md b/docs/index.md index d39431b..80bacc4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,15 +21,15 @@ hero: features: - title: Guide - icon: 🚀 + icon: details: Learn how to develop, configure, and run apps with abap2UI5. link: /get_started/introduction - title: GitHub - icon: 🦖 + icon: details: Jump into the code! Explore the repository, report issues, and contribute to the project. link: https://www.github.com/abap2UI5/abap2UI5 - title: LinkedIn - icon: linkedin + icon: details: Follow on LinkedIn and stay informed about latest updates and changes. link: https://www.linkedin.com/company/abap2ui5 --- \ No newline at end of file From ea25ce00b1166e9c3f5ec38c2439efbc79069009 Mon Sep 17 00:00:00 2001 From: oblomov-dev <102328295+oblomov-dev@users.noreply.github.com> Date: Sun, 13 Oct 2024 13:36:39 +0000 Subject: [PATCH 4/5] update --- docs/get_started/quickstart.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/get_started/quickstart.md b/docs/get_started/quickstart.md index 47abd69..60c0794 100644 --- a/docs/get_started/quickstart.md +++ b/docs/get_started/quickstart.md @@ -9,8 +9,8 @@ outline: [2, 4] Install the project with [abapGit.](https://abapgit.org) ![alt text](image.png) -### 2. Set up a new HTTP service -Create a new HTTP Service with the following handler implementation: +### 2. Create HTTP Handler +Create a new HTTP service with the appropriate handler implementation for your system: ::: code-group @@ -61,16 +61,37 @@ ENDCLASS. ``` ::: +Your system structure now looks like this: +``` +. +├─ abap2UI5 +│─ package +│ ├─ zcl_my_handler +``` + + +### 3. Create HTTP Endpoint +Create a new HTTP service and assign the handler implementation you created.
+Now, you can access abap2UI5 from your browser. The abap2UI5 framework and your custom HTTP handler have been successfully installed.
+Your system structure should now look like this:
+``` +. +├─ abap2UI5 +└─ package + ├─ zcl_my_handler + └─ icf artifact +``` ### 3. Start your App -Call your HTTP Service in the browser, press check and start the app: +Call your HTTP service in the browser, press check, and start your app: image
image -::: warning Security -The project does not connect to external systems. It communicates solely with the HTTP handler that you define. You are in complete control—decide who can access this handler and establish custom authentication methods. As your needs evolve, you can further refine the handler as you can see [here.](/configuration/general) +::: warning Information Security 💡 + +This project communicates solely with the HTTP handler that you define. You have complete control—decide who can access this handler and customize authentication methods. As your needs evolve, you can further refine the handler. See more details [here.](/configuration/general) ::: From dd92a944f48637f1973385ef611b6f9b1ea44dcb Mon Sep 17 00:00:00 2001 From: oblomov-dev <102328295+oblomov-dev@users.noreply.github.com> Date: Sun, 13 Oct 2024 13:54:35 +0000 Subject: [PATCH 5/5] update --- LICENSE | 1 + docs/.vitepress/config.mjs | 2 +- docs/resources/license.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 2191d79..a1e3c40 100644 --- a/LICENSE +++ b/LICENSE @@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 08b7b31..074a85f 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -41,7 +41,7 @@ export default defineConfig({ { text: 'Technical Insights', link: '/insights/insights' }, { text: 'Resources', link: '/resources/resources' }, ]}, - { text: 'Jump', items: [ + { text: 'Links', items: [ { text: 'Project', items: [ { text: 'abap2UI5', link: 'https://github.com/abap2UI5/abap2UI5' }, { text: 'samples', link: 'https://github.com/abap2UI5/samples' }, diff --git a/docs/resources/license.md b/docs/resources/license.md index 9e62b0e..ce87bfa 100644 --- a/docs/resources/license.md +++ b/docs/resources/license.md @@ -20,4 +20,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE.