diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index b3e348a..edf6781 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -20,8 +20,10 @@ export default defineConfig({ themeConfig: { logo: '/logo.png', footer: { - message: 'Released under the MIT License', - copyright: '2023-present abap2UI5' + message: ` + License | + Contact`, + copyright: `Copyright © 2023-${new Date().getFullYear()} abap2UI5`, }, editLink: { pattern: 'https://github.com/abap2UI5/abap2UI5-documentation/tree/main/docs/:path', @@ -101,12 +103,13 @@ export default defineConfig({ { text: 'Translation, i18n', link: '/development/translation' }, { text: 'Popups, Popover', link: '/development/popups' }, { text: 'Specifics', collapsed : "false" , items: [ - { text: 'Barcode Scanning', link: '/development/barcodes' }, - { text: 'File Handling', link: '/development/files', }, - { text: 'XLSX', link: '/development/xlsx', }, - { text: 'Logging', link: '/development/logging' }, - { text: 'Device Capabilities', link: '/development/ndc' }, - { text: 'CDS, EML', link: '/development/cds' }, + { text: 'Barcode Scanning', link: '/development/specific/barcodes' }, + { text: 'File Handling', link: '/development/specific/files', }, + { text: 'XLSX', link: '/development/specific/xlsx', }, + { text: 'Logging', link: '/development/specific/logging' }, + { text: 'Device Capabilities', link: '/development/specific/ndc' }, + { text: 'Drag & Drop', link: '/development/specific/drag' }, + { text: 'CDS, EML', link: '/development/specific/cds' }, ] }, ] @@ -158,7 +161,7 @@ export default defineConfig({ ] }, { text: 'Technical Background', collapsed : "false" , link: '/advanced/insights/insights' , items: [ { text: 'General', link: '/advanced/insights/insights' }, - { text: 'abaplint', link: '/advanced/insights/abaplint' }, + { text: 'Linting', link: '/advanced/insights/linting' }, { text: 'open-abap', link: '/advanced/insights/open_abap' }, ] }, @@ -171,9 +174,10 @@ export default defineConfig({ items: [ { text: 'Changelog', link: '/resources/changelog' }, { text: 'Blogs', link: '/resources/blogs' }, - { text: 'References', link: '/resources/references' }, { text: 'License', link: '/resources/license' }, + { text: 'Contact', link: '/resources/contact' }, { text: 'Community', items: [ + { text: 'References', link: '/resources/references' }, { text: 'Support', link: '/resources/support' }, { text: 'Contribution', link: '/resources/contribution' }, { text: 'Sponsor', link: '/resources/sponsor' }, @@ -182,14 +186,10 @@ export default defineConfig({ ] } ], + outline: [2,6], socialLinks: [ { icon: 'linkedin', link: 'https://www.linkedin.com/company/abap2ui5/' }, { icon: 'github', link: 'https://www.github.com/abap2UI5/abap2UI5' }, - ] }, - // Aktiviert den "On This Page"-Bereich - outline: { - level: [2,6] - } }) diff --git a/docs/advanced/insights/abaplint.md b/docs/advanced/insights/linting.md similarity index 51% rename from docs/advanced/insights/abaplint.md rename to docs/advanced/insights/linting.md index 5933990..23d8a5e 100644 --- a/docs/advanced/insights/abaplint.md +++ b/docs/advanced/insights/linting.md @@ -1,13 +1,23 @@ --- outline: [2, 4] --- -# abaplint +# Linting + +The frontend JS code and the backend abap code are static code checked with every PR. + +### abaplint The project uses [abaplint](https://abaplint.app/) for static code analysis, ensuring code quality and adherence to ABAP best practices. -### Configuration +#### Configuration You can review the project-specific abaplint configuration [here.](https://github.com/abap2UI5/abap2UI5/blob/main/ci/abaplint/abaplint.jsonc) -### Dashboard +#### Dashboard All statistics and results from the abaplint analysis are available on the abaplint dashboard [here.](https://abaplint.app/stats/abap2UI5/abap2UI5) +### ui5lint + +The project uses the [ui5linter]((https://github.com/SAP/ui5-linter)) for static code analysis of frontend artifacts. The linter checks for issues such as deprecated API usage and ensures compatibility with UI5 2.x. + +#### Configuration +The default configuration is applied. \ No newline at end of file diff --git a/docs/development/events.md b/docs/development/events.md index 3af7269..6c86135 100644 --- a/docs/development/events.md +++ b/docs/development/events.md @@ -119,8 +119,8 @@ METHOD z2ui5_if_app~main. ENDMETHOD. ``` -::: tipp -This is just a demonstration. In this case, it would be easier to access `mv_name` directly since it’s automatically updated by the framework. +::: tip +This is just a demonstration. In this case, it would be easier to access `name` directly since it’s automatically updated by the framework. ::: ### Frontend diff --git a/docs/development/barcodes.md b/docs/development/specific/barcodes.md similarity index 100% rename from docs/development/barcodes.md rename to docs/development/specific/barcodes.md diff --git a/docs/development/cds.md b/docs/development/specific/cds.md similarity index 100% rename from docs/development/cds.md rename to docs/development/specific/cds.md diff --git a/docs/development/specific/drag.md b/docs/development/specific/drag.md new file mode 100644 index 0000000..910e571 --- /dev/null +++ b/docs/development/specific/drag.md @@ -0,0 +1,3 @@ +# Drag & Drop + +With abap2UI5 you can leverages the drag-and-drop events of UI5 controls. To learn more, explore the sample `z2ui5_cl_demo_app_307`. \ No newline at end of file diff --git a/docs/development/files.md b/docs/development/specific/files.md similarity index 100% rename from docs/development/files.md rename to docs/development/specific/files.md diff --git a/docs/development/logging.md b/docs/development/specific/logging.md similarity index 100% rename from docs/development/logging.md rename to docs/development/specific/logging.md diff --git a/docs/development/ndc.md b/docs/development/specific/ndc.md similarity index 100% rename from docs/development/ndc.md rename to docs/development/specific/ndc.md diff --git a/docs/development/xlsx.md b/docs/development/specific/xlsx.md similarity index 100% rename from docs/development/xlsx.md rename to docs/development/specific/xlsx.md diff --git a/docs/get_started/about.md b/docs/get_started/about.md index 0e7803d..f16b09a 100644 --- a/docs/get_started/about.md +++ b/docs/get_started/about.md @@ -22,7 +22,7 @@ Each application is supported as an abapGit project, simplifying installation ac 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. ##### Performance -abap2UI5 is fast. By leveraging the power of the ABAP backend for most processes, it ensures faster execution compared to client-side operations. The frontend focuses solely on rendering UI via the UI5 framework. +abap2UI5 is fast! By leveraging the power of the ABAP backend for most processes, it ensures faster execution compared to client-side operations. The frontend focuses solely on rendering UI via the UI5 framework. ##### System Footprint 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. diff --git a/docs/resources/contact.md b/docs/resources/contact.md new file mode 100644 index 0000000..7e65866 --- /dev/null +++ b/docs/resources/contact.md @@ -0,0 +1,9 @@ +# Contact + +abap2UI5 is a public project that values transparent and publicly visible communication. Whenever possible, please use public channels so others can join the conversation and benefit from the discussion. Reach out through the following platforms: + +* Social Media: Share your thoughts on [LinkedIn posts](https://www.linkedin.com/company/abap2ui5) +* Repository: Open an issue or join discussions in the [GitHub repository](https://github.com/abap2UI5/abap2UI5/issues) +* Slack: Connect on the abap2UI5 channel on [abapGit Slack](https://communityinviter.com/apps/abapgit/abap) + +For private inquiries, you can email at . This is a spare-time project, responses might take a little longer. \ No newline at end of file