Skip to content

Commit

Permalink
[EDP-DDM-00000] github: Added licensing info
Browse files Browse the repository at this point in the history
Change-Id: I74d43248b490ade05cf5d9305b8f4983758ba48d
  • Loading branch information
[email protected] committed Mar 5, 2024
1 parent b89df87 commit fa28739
Show file tree
Hide file tree
Showing 8 changed files with 83 additions and 81 deletions.
61 changes: 31 additions & 30 deletions docs/en/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
= Platform for state registries
include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

= Platform for state registries
include::platform:ROOT:partial$admonitions/language-en.adoc[]

== About the Platform

*_The Platform for state registries_* is an information system designed to _deliver government services in a digital format efficiently_. It enables the rapid creation, modeling, deployment, and maintenance of electronic state registries, striking an optimal balance between data security requirements, deployment speed, registry ownership costs, and data exchange with other registries.

include::platform:ROOT:partial$admonitions/os-apache-license-en.adoc[]

.Context diagram of the Platform
image::arch:architecture/ddm-platform-context.svg[]

Expand All @@ -15,50 +18,48 @@ image::arch:architecture/ddm-platform-context.svg[]

Across the globe, many countries are grappling with a need for uniformity in how their public state registers are created and managed. This inconsistency stymies the practical application of crucial principles of digital development policy, such as reusability, technology neutrality, data portability, interoperability, security, and confidentiality. Consequently, this results in increased complexity in delivering administrative services while also acting as a roadblock to their transition to online platforms.

In the case of Ukraine, there exist over 350 state registries, each with distinct ownership. Individual teams are responsible for creating and maintaining each registry, and they each operate on their dedicated infrastructure, whether physical hardware or a cloud-based solution.
In the case of Ukraine, over 450 state registries exist, each with distinct ownership. Individual teams are responsible for creating and maintaining each registry, and they each operate on their dedicated infrastructure, whether physical hardware or a cloud-based solution.

The current situation can be characterized as both decentralized and unregulated: ::
The current situation can be characterized as both *_decentralized_* and *_unregulated_*:

*_Decentralized_* refers to separate infrastructures for data storage maintained by different owners. This distinction is crucial regarding data collection, storage, and usage accountability.
+
*_Unregulated_* signifies the absence of guarantees that the registries interact correctly. This interaction should occur over secure connections, comply with data retention policies, and align with software reuse and resource optimization principles.
* *_Decentralized_* refers to separate infrastructures for data storage maintained by different owners. This distinction is crucial regarding data collection, storage, and usage accountability.

* *_Unregulated_* signifies the absence of guarantees that the registries interact correctly. This interaction should occur over secure connections, comply with data retention policies, and align with software reuse and resource optimization principles.

=== The concept of a platform for deploying registries and solving the problem

Given the current situation and potential risks associated with defining responsibility for data protection, the Platform advocates a shift towards a *_decentralized_* but *_regulated_* approach.

This approach guarantees the preservation of data owner identification, establishing _clear data responsibility_. Simultaneously, it lays the groundwork for further Platform enhancements, positioning registries as a complex of hardware and software tools. These tools are designed to implement the requirements the Ministry of Digital Transformation of Ukraine set forth.
This approach guarantees the preservation of data owner identification, establishing *_clear data responsibility_*. Simultaneously, it lays the groundwork for further Platform enhancements, positioning registries as a complex of hardware and software tools. These tools are designed to implement the Ministry of Digital Transformation of Ukraine's requirements.

//== З чого почати?
== Getting started

//Цей сайт є базою знань, яка допоможе вам краще зрозуміти продукт.
//This knowledge base will help you better understand the product.
Welcome to our comprehensive knowledge base! Whether you're navigating the complexities of our Platform or looking to deepen your understanding of specific areas, we've got you covered. Dive into the sections tailored just for you:

* [*] *For Platform infrastructure wizards*: Are you the backbone of our Platform's infrastructure, security, or access management? Your journey starts here: xref:admin:admin-overview.adoc[Platform administrators].

* [*] *For registry development heroes*: Part of the team deploying registries with finesse? Discover your guide at xref:registry-develop:overview.adoc[Registry development and maintenance teams].

* [*] *For registry administrators*: Steering the ship of registry management? Anchor here: xref:registry-develop:registry-admin/index.adoc[Registry administrators].

* [*] *For data modeling magicians*: Crafting operational data structures, declarative model descriptions, and creating analytical reports? Your spellbook is waiting: xref:registry-develop:data-modeling/index.adoc[Data modelers].

* [*] *For BPMN and UI Form sculptors*: Modeling business processes and UI forms with BPMN, DMN, Groovy, and JSON? Carve out your niche: xref:registry-develop:bp-modeling/index.adoc[Business process modelers].

//Меню навігації містить такі основні розділи за призначенням: ::
* [*] *Seeking learning opportunities* and wanting to learn more and gain practical skills? Visit the following:

This knowledge base contains the following main sections: ::
** *For registry regulations explorers*:
Ready for a deep dive into the world of registry regulations? Embark on a particular xref:registry-develop:study-project/index.adoc[Study course for registry regulations developers] packed with educational tasks and quizzes to hone your modeling skills.

//TODO: add link
* To learn about new features and enhancements, see xref:release-notes:overview.adoc[What's new].
+
//TODO: add link
* If you are a Platform infrastructure administrator, security administrator, or access administrator, see xref:admin:admin-overview.adoc[].
+
//TODO: add link
* If you are a development and maintenance team member that deploys registries using the Platform, see xref:registry-develop:overview.adoc[Registry development and maintenance].
+
//TODO: add link
* If you are a registry administrator, see xref:registry-develop:registry-admin/index.adoc[Registry administrators].
** *For technical registry administrators*:
Don't stop there; for technical registry administrators, another journey awaits xref:registry-develop:registry-admin-study/registry-admin-study.adoc[Registry administrators onboarding].

* If you are a data modeler who works with operational data structures and declarative model descriptions and creates analytical reports, see xref:registry-develop:data-modeling/index.adoc[].
* [*] *For service providers, government officers, service recipients, and citizens*: Engaging with the user portal as part of business processes? Your portal awaits at xref:user: an overview.adoc[User documentation].

* If you are a modeler of business processes and UI forms for business processes, who works with BPMN, DMN, Groovy scripting, and JSON structures, see xref:registry-develop:bp-modeling/index.adoc[].
* [*] *For developers, architects, and tech gurus*: Craving a deeper understanding of our architecture? Explore xref:arch:architecture/overview.adoc[Architecture documentation].

* For a deep dive into the regulations structures, take a special xref:registry-develop:study-project/index.adoc[Study course for registry regulations developers]. This training provides a number of educational tasks and quizzes that will help you gain practical skills in regulations modeling.
//* Якщо ви посадова особа, або отримувач послуг реєстру, працюєте з особистим кабінетом у рамках бізнес-процесів, зверніться до розділу xref:user:overview.adoc[].
* If you are a government officer or a citizen working with the user portal as part of business processes, see xref:user:overview.adoc[].
* [*] Familiarize yourself with the *key terms and definitions* critically important for understanding our Platform. Your encyclopedia awaits at xref:platform-glossary.adoc[Platform Glossary]. Here, you will find all the necessary information to dive into the specifics and language of our system, which will help you better navigate and effectively work with our tools and resources.

* If you are a developer, architect, or just a tech guru, see xref:arch:architecture/overview.adoc[].
//* *Got questions?* We've got answers! Check out: xref:faq:faq.adoc[].

* Have a question? See xref:faq:faq.adoc[].
Jump into the sections that resonate with your role and embark on a journey to master the ins and outs of our Platform. Let's explore together!
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
NOTE: _The Platform for state registries_ is distributed as open-source software under the https://www.apache.org/licenses/LICENSE-2.0[Apache License v2.0].
26 changes: 14 additions & 12 deletions docs/en/modules/arch/pages/architecture/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]

include::platform:ROOT:partial$admonitions/language-en.adoc[]

== General overview
== Overview

*_The Platform for state registries_* is an information system designed to _deliver government services in a digital format efficiently_. It enables the rapid creation, modeling, deployment, and maintenance of electronic state registries.

The main objective of this solution is to implement a _decentralized_ and _regulated_ approach to managing state registries. This product aims to balance _data security requirements_, _interoperability_, _deployment speed_, and the _cost_ of registry ownership.

include::platform:ROOT:partial$admonitions/os-apache-license-en.adoc[]

== Main purpose

*_The Registries Platform_* aims to address several problems with the current state of government information registries, which complicate the process of digitizing government services:
Expand All @@ -24,7 +26,7 @@ The main objective of this solution is to implement a _decentralized_ and _regul

== Business drivers

* 100% of government services available to citizens and businesses in digital format.
* 100% of government services are available to citizens and businesses in digital format.

== Business objectives

Expand Down Expand Up @@ -59,18 +61,18 @@ The main objective of this solution is to implement a _decentralized_ and _regul
* Public API for registry data and rate limit management;
* Data access rights management using _RBAC_;
* Building analytical reports based on registry data;
* Generating extracts based on registry data, and more.
* Generating extracts based on registry data and more.

== Architectural documentation sections

The _Registries Platform_ technical documentation package includes:

* xref:arch:architecture/platform-conceptual.adoc[] -- description of the conceptual design of the solution, end-users of the _Registries Platform_, and external systems with which interaction is built
* xref:arch:architecture/platform-logical.adoc[] -- high-level structure of the solution with a description of its decomposition into components (zones, subsystems, etc.) and the interaction between them
* xref:arch:architecture/platform-deployment.adoc[] -- deployment architecture of the _Registries Platform_
* xref:arch:architecture/platform-system-requirements/overview.adoc[] -- description of system requirements for deploying the _Registries Platform_ on the target infrastructure
* xref:arch:architecture/security/overview.adoc[] -- technical documentation describing the security architecture of the _Registries Platform_
* xref:arch:architecture/platform-technologies.adoc[] -- description of the list and categories of key technologies applied in building the _Registries Platform_ solution
* xref:arch:architecture/platform-quality-attributes/overview.adoc[] -- key quality attributes with descriptions of approaches and techniques for addressing them
* _High-level design of zones and subsystems of the Platform_ -- a set of sections with a high-level architecture, descriptions of components and their interactions, key aspects of the solution, and so on.
* xref:arch:architecture/platform-api/overview.adoc[] -- documentation of the _API_ services of the _Registries Platform_
* xref:arch:architecture/platform-conceptual.adoc[] description of the conceptual design of the solution, end-users of the _Registries Platform_, and external systems with which interaction is built.
* xref:arch:architecture/platform-logical.adoc[] — the high-level structure of the solution with a description of its decomposition into components (zones, subsystems, and so on) and the interaction between them.
* xref:arch:architecture/platform-deployment.adoc[] deployment architecture of the _Registries Platform_.
* xref:arch:architecture/platform-system-requirements/overview.adoc[] description of system requirements for deploying the _Registries Platform_ on the target infrastructure.
* xref:arch:architecture/security/overview.adoc[] technical documentation describing the security architecture of the _Registries Platform_.
* xref:arch:architecture/platform-technologies.adoc[] description of the list and categories of key technologies applied in building the _Registries Platform_ solution.
* xref:arch:architecture/platform-quality-attributes/overview.adoc[] key quality attributes with descriptions of approaches and techniques for addressing them.
* _High-level design of zones and subsystems of the Platform_ a set of sections with a high-level architecture, descriptions of components and their interactions, key aspects of the solution, and so on.
* xref:arch:architecture/platform-api/overview.adoc[] documentation of the _API_ services of the _Registries Platform_.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ include::platform:ROOT:partial$admonitions/language-en.adoc[]

This high-level diagram illustrates the key technologies and how they address the functional and non-functional requirements of the _Registries Platform_.

include::platform:ROOT:partial$admonitions/os-apache-license-en.adoc[]

.High-level structure diagram. Technology stack
image::architecture/ddm-platform-tech-view.svg[]

== Programming languages
Expand Down
Loading

0 comments on commit fa28739

Please sign in to comment.