From 6ebb070acdaa5a5e063e4d9b0a21921283269969 Mon Sep 17 00:00:00 2001 From: Christian Badura <93912698+cbadura@users.noreply.github.com> Date: Thu, 12 Sep 2024 11:23:22 +0200 Subject: [PATCH] Change antora setup to include General page (#7) * feat: change antora setup * feat: create userdocs files --------- Co-authored-by: Christian Badura --- .vscode/settings.json | 3 ++ docs/antora.yml | 10 ++-- docs/modules/general/nav.adoc | 1 + docs/modules/general/pages/index.adoc | 54 +++++++++++++++++++ docs/modules/nav.adoc | 1 - .../onecx-announcement/pages/index.adoc | 5 -- userdocs/antora.yml | 8 +++ userdocs/modules/general/nav.adoc | 1 + userdocs/modules/general/pages/index.adoc | 1 + 9 files changed, 74 insertions(+), 10 deletions(-) create mode 100644 .vscode/settings.json create mode 100644 docs/modules/general/nav.adoc create mode 100644 docs/modules/general/pages/index.adoc delete mode 100644 docs/modules/nav.adoc delete mode 100644 docs/modules/onecx-announcement/pages/index.adoc create mode 100644 userdocs/antora.yml create mode 100644 userdocs/modules/general/nav.adoc create mode 100644 userdocs/modules/general/pages/index.adoc diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..ce670e4 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "asciidoc.antora.enableAntoraSupport": true +} diff --git a/docs/antora.yml b/docs/antora.yml index e23d430..4b47999 100644 --- 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 \ No newline at end of file + - modules/general/nav.adoc + - modules/onecx-announcement-ui/nav.adoc + - modules/onecx-announcement-bff/nav.adoc + - modules/onecx-announcement-svc/nav.adoc + \ No newline at end of file diff --git a/docs/modules/general/nav.adoc b/docs/modules/general/nav.adoc new file mode 100644 index 0000000..5c67ff9 --- /dev/null +++ b/docs/modules/general/nav.adoc @@ -0,0 +1 @@ +* xref:general:index.adoc[General] \ No newline at end of file diff --git a/docs/modules/general/pages/index.adoc b/docs/modules/general/pages/index.adoc new file mode 100644 index 0000000..a671a7d --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/modules/nav.adoc b/docs/modules/nav.adoc deleted file mode 100644 index a1b7bdc..0000000 --- a/docs/modules/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:onecx-announcement:index.adoc[Announcement Management] \ No newline at end of file diff --git a/docs/modules/onecx-announcement/pages/index.adoc b/docs/modules/onecx-announcement/pages/index.adoc deleted file mode 100644 index e4f8673..0000000 --- a/docs/modules/onecx-announcement/pages/index.adoc +++ /dev/null @@ -1,5 +0,0 @@ -= 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. \ No newline at end of file diff --git a/userdocs/antora.yml b/userdocs/antora.yml new file mode 100644 index 0000000..53b59d8 --- /dev/null +++ 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 new file mode 100644 index 0000000..5c67ff9 --- /dev/null +++ b/userdocs/modules/general/nav.adoc @@ -0,0 +1 @@ +* xref:general:index.adoc[General] \ No newline at end of file diff --git a/userdocs/modules/general/pages/index.adoc b/userdocs/modules/general/pages/index.adoc new file mode 100644 index 0000000..fb34e93 --- /dev/null +++ b/userdocs/modules/general/pages/index.adoc @@ -0,0 +1 @@ += OneCX Announcement Management