Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update #18

Merged
merged 10 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ export default defineConfig({
themeConfig: {
logo: '/logo.png',
footer: {
message: 'Released under the MIT License',
copyright: '2023-present abap2UI5'
message: `
<a href="/docs/resources/license">License</a> |
<a href="/docs/resources/contact">Contact</a>`,
copyright: `Copyright © 2023-${new Date().getFullYear()} abap2UI5`,
},
editLink: {
pattern: 'https://github.com/abap2UI5/abap2UI5-documentation/tree/main/docs/:path',
Expand Down Expand Up @@ -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' },
]
},
]
Expand Down Expand Up @@ -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' },
]
},
Expand All @@ -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' },
Expand All @@ -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]
}
})
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions docs/development/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/development/specific/drag.md
Original file line number Diff line number Diff line change
@@ -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`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/get_started/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 9 additions & 0 deletions docs/resources/contact.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>. This is a spare-time project, responses might take a little longer.