feat: create userdocs and docs files (#6)

Co-authored-by: Christian Badura <[email protected]>

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "asciidoc.antora.enableAntoraSupport": true
+}

docs/antora.yml

@@ -1,9 +1,9 @@
 name: onecx-user-profile
-title: User Profile Management
+title: User Profile
 version: latest
-start_page: onecx-user-profile:index.adoc
+start_page: general:index.adoc
 nav:
-  - modules/onecx-user-profile/nav.adoc
-  - modules/onecx-user-profile-svc/nav.adoc
-  - modules/onecx-user-profile-avatar-svc/nav.adoc
-  - modules/onecx-user-profile-bff/nav.adoc
+  - modules/general/nav.adoc
+  - modules/onecx-user-profile-ui/nav.adoc
+  - modules/onecx-user-profile-bff/nav.adoc
+  - modules/onecx-user-profile-ui/nav.adoc

docs/modules/general/pages/index.adoc

@@ -0,0 +1,53 @@
+= OneCX User Profile
+
+== Licence
+This software is licensed under the Apache License, Version 2.0.
+You may obtain a copy of the license in the corresponding LICENSE file or visit the link:https://www.apache.org/licenses/LICENSE-2.0[Apache website] for more information.
+
+== Contributing
+We welcome contributions from the community.
+If you would like to contribute to the development of OneCX User Profile Software, please follow our contribution guidelines (tbd).
+
+== What is User Profile?
+User Profile refers to storing and retrieving User Profiles usable in context of OneCX applications.
+
+== Key Features
+* User Profile Storage and Retrieval: Store and retrieve User Profiles usable in context of OneCX applications.
+
+== Issue tracking
+All OneCX User Profile issues are tracked and maintained at the link:https://xyz.com[issue tracking tool].
+
+== Overview
+OneCX User Profile Software is a comprehensive solution for managing User Profiles in a user-friendly and efficient manner.
+It is a solution that consists of three main components: a backend service, a user interface and a backend-for-frontend (BFF) layer.
+
+The three components of the OneCX User Profile Software are as follows:
+
+. User Profile User Interface (UI)
+  The user interface component is based on Angular, a popular JavaScript framework for building dynamic web applications.
+  It offers a user-friendly and intuitive interface for interacting with the User Profile system.
+  Users can perform actions such as searching and editing of User Profiles.
+
+. User Profile Backend for Frontend (BFF)
+  The BFF layer acts as an intermediary between the frontend user interface and the backend service.
+  It handles tasks such as data aggregation, transformation, and composition to provide an optimized API for the UI.
+  The BFF layer is designed to enhance performance and simplify the integration of the frontend with the backend service.
+
+. User Profile Backend Service (SVC)
+  This component provides the core functionality.
+  It handles tasks such as storage, retrieval and editing of User Profiles.
+  The backend is built cloud native using Quarkus.
+
+Interfaces are based on the TM-Forum standard link:https://github.com/tmforum-apis/TMF667_Document[TMF 667].
+
+== Getting Started
+To get started with OneCX User Profile Software, please refer to the following installation and setup instructions specific to each component:
+
+* link:https://onecx.github.io/docs/onecx-user-profile/current/onecx-user-profile-ui/index.html[OneCX User Profile UI (User Interface) - Getting Started]
+* link:https://onecx.github.io/docs/onecx-user-profile/current/onecx-user-profile-bff/index.html[OneCX User Profile BFF (Backend for Frontend) - Getting Started]
+* link:https://onecx.github.io/docs/onecx-user-profile/current/onecx-user-profile-svc/index.html[OneCX User Profile SVC (Backend) - Getting Started]
+
+For detailed usage instructions and API documentation, please refer to the respective documentation files for each component.
+
+== Roadmap
+tbd

docs/modules/nav.adoc

@@ -1 +1 @@
-* xref:onecx-user-profile:index.adoc[User Profile Management]
+* xref:general:index.adoc[General]

userdocs/antora.yml

@@ -0,0 +1,8 @@
+name: onecx-user-profile
+title: User Profile
+version: latest
+start_page: general:index.adoc
+nav:
+ - modules/general/nav.adoc
+ - modules/ui/nav.adoc
+

userdocs/modules/general/nav.adoc

@@ -0,0 +1 @@
+* xref:general:index.adoc[General]

userdocs/modules/general/pages/index.adoc

@@ -0,0 +1 @@
+= OneCX User Profile