Change antora setup to include General page (#7)

* feat: change antora setup * feat: create userdocs files --------- Co-authored-by: Christian Badura <[email protected]>
onecx · Sep 12, 2024 · 6ebb070 · 6ebb070
1 parent f6c7ca4
commit 6ebb070
Show file tree

Hide file tree

Showing 9 changed files with 74 additions and 10 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "asciidoc.antora.enableAntoraSupport": true
+}
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -1,8 +1,10 @@
 name: onecx-announcement
 title: Announcement Management
 version: latest
-start_page: onecx-announcement:index.adoc
+start_page: general:index.adoc
 nav:
-  - modules/onecx-announcement/nav.adoc
-  - modules/onecx-announcement-svc/nav.adoc
-  - modules/onecx-announcement-bff/nav.adoc
+ - modules/general/nav.adoc
+ - modules/onecx-announcement-ui/nav.adoc
+ - modules/onecx-announcement-bff/nav.adoc
+ - modules/onecx-announcement-svc/nav.adoc
+
diff --git a/docs/modules/general/nav.adoc b/docs/modules/general/nav.adoc
@@ -0,0 +1 @@
+* xref:general:index.adoc[General]
diff --git a/docs/modules/general/pages/index.adoc b/docs/modules/general/pages/index.adoc
@@ -0,0 +1,54 @@
+= OneCX Announcement Management
+
+== 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 Announcement Management Software, please follow our contribution guidelines (tbd).
+
+== What is Announcement Management
+Announcement management refers to storing and retrieving Announcement items usable in context of OneCX applications.
+
+== Key Features
+
+* Announcement Item Storage and Retrieval: Store and retrieve Announcement items usable in context of OneCX applications.
+
+== Issue tracking
+All OneCX Announcement Management issues are tracked and maintained at the link:https://xyz.com[issue tracking tool].
+
+== Overview
+OneCX Announcement Management Software is a comprehensive solution for managing Announcement items 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 OneCX Announcement Management Software are as follows:
+
+. Announcement Management 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 Announcement management system.
+  Users can perform actions such as searching and editing of Announcement items.
+
+. Announcement Management 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.
+
+. Announcement Management Backend Service (SVC)
+  This component provides the core functionality.
+  It handles tasks such as storage, retrieval and editing of Announcement items.
+  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 Announcement Management Software, please refer to the following installation and setup instructions specific to each component:
+
+* link:https://onecx.github.io/docs/onecx-announcement/current/onecx-announcement-ui/index.html[OneCX Announcement Management UI (User Interface) - Getting Started]
+* link:https://onecx.github.io/docs/onecx-announcement/current/onecx-announcement-bff/index.html[OneCX Announcement Management BFF (Backend for Frontend) - Getting Started]
+* link:https://onecx.github.io/docs/onecx-announcement/current/onecx-announcement-svc/index.html[OneCX Announcement Management SVC (Backend) - Getting Started]
+
+For detailed usage instructions and API documentation, please refer to the respective documentation files for each component.
+
+== Roadmap
+tbd
diff --git a/docs/modules/nav.adoc b/docs/modules/nav.adoc
diff --git a/docs/modules/onecx-announcement/pages/index.adoc b/docs/modules/onecx-announcement/pages/index.adoc
diff --git a/userdocs/antora.yml b/userdocs/antora.yml
@@ -0,0 +1,8 @@
+name: onecx-announcement
+title: Announcement Management
+version: latest
+start_page: general:index.adoc
+nav:
+ - modules/general/nav.adoc
+ - modules/ui/nav.adoc
+
diff --git a/userdocs/modules/general/nav.adoc b/userdocs/modules/general/nav.adoc
@@ -0,0 +1 @@
+* xref:general:index.adoc[General]
diff --git a/userdocs/modules/general/pages/index.adoc b/userdocs/modules/general/pages/index.adoc
@@ -0,0 +1 @@
+= OneCX Announcement Management