From 7a94998db60d018f0040e012024ae473b9eb1f02 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Fri, 11 Nov 2022 11:54:25 -0800 Subject: [PATCH 1/9] ENDOC-599 --- vuepress/docs/next/docs/reference/glossary.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 vuepress/docs/next/docs/reference/glossary.md diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md new file mode 100644 index 0000000000..3d24dac0b4 --- /dev/null +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -0,0 +1,15 @@ +# Entando Glossary + +## Entando Terms + +| Term | Description +|:--|:-- +| Entando Platform | Core product comprising the complete set of software used to build Entando solutions, applications, sites or portals | +| Entando Business Automation Bundle | Widgets and integration code required to support solutions built on process automation engines, primarily Red Hat Process Automation | +| Entando Architectural Review | Consultation package offering an architectural review of new or proposed implementations | +| Entando Getting Started Service | Consultation package includes setup of dev, test, production environments, sizing and architecture recommendations, discussions and analysis for HA and scalability | +| Entando Go Live Service | Consultation package offering expert help for issues arising in the final stages of a project, up to and including post-launch of a new Entando Application | +| Entando Innovation Labs | Consultation package multi-day session where customer and Entando build an initial application together, allowing the customer to learn our methodology and platform, which they can then use to train others in their company. +| Entando Upgrade Analysis | +| Entando UX Standardization | +| Entando Web Application Security Analysis Service | From 12f581bc709c61f289b70e844dcd0def4f2e2071 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Fri, 11 Nov 2022 11:55:01 -0800 Subject: [PATCH 2/9] ENDOC-599 --- vuepress/docs/next/docs/reference/glossary.md | 78 ++++++++++++++++--- 1 file changed, 69 insertions(+), 9 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index 3d24dac0b4..ccadb4c6f4 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -2,14 +2,74 @@ ## Entando Terms +### Core Products + +| Term | Description +|:--|:-- +| Entando Platform | Comprises the complete set of software used to build Entando solutions, applications, sites or portals | + +### Solutions + | Term | Description |:--|:-- -| Entando Platform | Core product comprising the complete set of software used to build Entando solutions, applications, sites or portals | -| Entando Business Automation Bundle | Widgets and integration code required to support solutions built on process automation engines, primarily Red Hat Process Automation | -| Entando Architectural Review | Consultation package offering an architectural review of new or proposed implementations | -| Entando Getting Started Service | Consultation package includes setup of dev, test, production environments, sizing and architecture recommendations, discussions and analysis for HA and scalability | -| Entando Go Live Service | Consultation package offering expert help for issues arising in the final stages of a project, up to and including post-launch of a new Entando Application | -| Entando Innovation Labs | Consultation package multi-day session where customer and Entando build an initial application together, allowing the customer to learn our methodology and platform, which they can then use to train others in their company. -| Entando Upgrade Analysis | -| Entando UX Standardization | -| Entando Web Application Security Analysis Service | +| Entando Business Automation Bundle | Widgets and integration code required to support solutions built on process automation engines, e.g. Red Hat Process Automation | + +### Consulting Packages + +| Term | Description +|:--|:-- +| Entando Architectural Review | Offers an architectural review of new or proposed implementations | +| Entando Getting Started Service | Includes setup of dev, test, production environments, sizing and architecture recommendations, discussions and analysis for HA and scalability | +| Entando Go Live Service | Provides expert help for issues arising in the final stages of a project, up to and including post-launch of a new Entando Application | +| Entando Innovation Labs | Offers a multi-day session over which the customer and Entando build an initial application together to teach the customer Entando's methodology and platform | +| Entando Upgrade Analysis | Reviews customer requirements and upgrade Entando to a later version | +| Entando UX Standardization | Reviews methods to standardize UX across an enterprise | +| Entando Web Application Security Analysis Service | Evaluates business vulnerabilities and designs a mitigation plan, in addition to solving known security issues | + +### Modules and Capabilities + +| Term | Description +|:--|:-- +| Entando Application | An application running on the Entando Platform and available at a given URL | +| Entando App Builder | The frontend of the Entando Platform. Hosts the Entnado WCMS and provides the UI to interact with and configure Entando components. | +| Entando App Engine | The core runtime engine for applications built with Entando App Builder. Provides the composition and rendering of the final application. | +| Entando Bundle | A package built with Entando that contains one or more components | +| Entando CLI (ent CLI) | Entando's core command line interface | +| Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | +| Entando Component Generator (ECG) | An implementation of a JHipster blueprint that provides automation and templating to generate the components used to build an Entando Application | +| Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs contained in an Entando Bundle | +| Entando Hub | A repository (local, remote, public, or private) containing Entando components. A single Entando App Builder can connect to 1 or more Entando Hubs. | +| Entando Identity Management System | Entando's user management and authentication/authorization system, powered by Keycloak | +| Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | +| Entando Web Content Management System (WCMS) | Entando's web content management system | +| Local Hub | The local component repository in an Entando App Builder | +| Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | +| Entando Portal UI | +| Kubernetes integration service | Provides an abstraction layer between Entando microservices and the APIs exposed by a Kubernetes cluster | + +## General Technical Terms + +| Term | Description +|:--|:-- +| backend for frontend (BFF) | A software architecture pattern that connects the frontend of an application with the backend microservices | +| component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | +| component collection | A packaged set of single components that are in some way functionally unrelated | +| content | The information/data contained within a component | +| content type | The structure of specific content, defined by a set of content attributes | +| content attribute | The basic data that define a content type | +| content template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | +| digital asset | Images, documents, and other media files supported in a specific format | +| low-code | A software development approach that leverages visual interfaces with basic logic and drag-and-drop capabilities to build applications and processes | +| micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | +| microservice | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | +| module | A basic element partitioned into a system of building blocks (e.g. PBCs, components, bundles, templates) that are independent, reusable, and can easily be configured into complex and useful structures | +| no-code | A programming platform on which applications are built exclusively using a visual development interface to drag and drop software components | +| pro-code | The traditional coding technique that relies on complex programming languages to build products such as websites and software | +| site template | A bundle or collection of bundles that encompasses the functionality to bootstrap development of an Entando Application. A site template does not contain capabilities focused on specific business requirements but can be contained within an Entando solution template. | +| solution template | A pre-packaged set of PBCs, component collections and single components providing a full-featured, domain specific solution | +| UX fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | +| web UI | The part of the Entando App Engine that provides tools to create an application's interactive user interface, including the primary engine to assemble components and push the page to the browser | + + + + From af2e92e9c85bbb9d327266ffece943c3915e836c Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Fri, 11 Nov 2022 14:19:37 -0800 Subject: [PATCH 3/9] ENDOC-599 Apply PR feedback --- vuepress/docs/next/docs/reference/glossary.md | 48 ++++--------------- 1 file changed, 10 insertions(+), 38 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index ccadb4c6f4..bfd8bcc226 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -2,32 +2,6 @@ ## Entando Terms -### Core Products - -| Term | Description -|:--|:-- -| Entando Platform | Comprises the complete set of software used to build Entando solutions, applications, sites or portals | - -### Solutions - -| Term | Description -|:--|:-- -| Entando Business Automation Bundle | Widgets and integration code required to support solutions built on process automation engines, e.g. Red Hat Process Automation | - -### Consulting Packages - -| Term | Description -|:--|:-- -| Entando Architectural Review | Offers an architectural review of new or proposed implementations | -| Entando Getting Started Service | Includes setup of dev, test, production environments, sizing and architecture recommendations, discussions and analysis for HA and scalability | -| Entando Go Live Service | Provides expert help for issues arising in the final stages of a project, up to and including post-launch of a new Entando Application | -| Entando Innovation Labs | Offers a multi-day session over which the customer and Entando build an initial application together to teach the customer Entando's methodology and platform | -| Entando Upgrade Analysis | Reviews customer requirements and upgrade Entando to a later version | -| Entando UX Standardization | Reviews methods to standardize UX across an enterprise | -| Entando Web Application Security Analysis Service | Evaluates business vulnerabilities and designs a mitigation plan, in addition to solving known security issues | - -### Modules and Capabilities - | Term | Description |:--|:-- | Entando Application | An application running on the Entando Platform and available at a given URL | @@ -38,37 +12,35 @@ | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | | Entando Component Generator (ECG) | An implementation of a JHipster blueprint that provides automation and templating to generate the components used to build an Entando Application | | Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs contained in an Entando Bundle | +| Entando Content | The information/data contained within a component | +| Entando Content Type | The structure of specific content, defined by a set of content attributes | +| Entando Content Attribute | The basic data that define a content type | +| Entando Content Template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | +| Entando Digital Asset | Images, documents, and other media files supported in a specific format | | Entando Hub | A repository (local, remote, public, or private) containing Entando components. A single Entando App Builder can connect to 1 or more Entando Hubs. | | Entando Identity Management System | Entando's user management and authentication/authorization system, powered by Keycloak | +| Entando Kubernetes integration service (k8s-service) | Provides an abstraction layer between Entando microservices and the APIs exposed by a Kubernetes cluster | | Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | | Entando Web Content Management System (WCMS) | Entando's web content management system | | Local Hub | The local component repository in an Entando App Builder | | Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | -| Entando Portal UI | -| Kubernetes integration service | Provides an abstraction layer between Entando microservices and the APIs exposed by a Kubernetes cluster | +| Entando UX Fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | ## General Technical Terms | Term | Description |:--|:-- -| backend for frontend (BFF) | A software architecture pattern that connects the frontend of an application with the backend microservices | +| backend for frontend (BFF) | A type of microservice dedicated to a frontend that may also act as a facade to other enterprise microservices | | component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | | component collection | A packaged set of single components that are in some way functionally unrelated | -| content | The information/data contained within a component | -| content type | The structure of specific content, defined by a set of content attributes | -| content attribute | The basic data that define a content type | -| content template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | -| digital asset | Images, documents, and other media files supported in a specific format | | low-code | A software development approach that leverages visual interfaces with basic logic and drag-and-drop capabilities to build applications and processes | | micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | | microservice | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | | module | A basic element partitioned into a system of building blocks (e.g. PBCs, components, bundles, templates) that are independent, reusable, and can easily be configured into complex and useful structures | | no-code | A programming platform on which applications are built exclusively using a visual development interface to drag and drop software components | | pro-code | The traditional coding technique that relies on complex programming languages to build products such as websites and software | -| site template | A bundle or collection of bundles that encompasses the functionality to bootstrap development of an Entando Application. A site template does not contain capabilities focused on specific business requirements but can be contained within an Entando solution template. | -| solution template | A pre-packaged set of PBCs, component collections and single components providing a full-featured, domain specific solution | -| UX fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | -| web UI | The part of the Entando App Engine that provides tools to create an application's interactive user interface, including the primary engine to assemble components and push the page to the browser | + + From 0c222760385a3af422871209bbe712de836409ec Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Mon, 14 Nov 2022 12:45:49 -0800 Subject: [PATCH 4/9] ENDOC-599 Minor additions --- vuepress/docs/next/docs/reference/glossary.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index bfd8bcc226..40079f19e8 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -12,7 +12,7 @@ | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | | Entando Component Generator (ECG) | An implementation of a JHipster blueprint that provides automation and templating to generate the components used to build an Entando Application | | Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs contained in an Entando Bundle | -| Entando Content | The information/data contained within a component | +| Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | | Entando Content Type | The structure of specific content, defined by a set of content attributes | | Entando Content Attribute | The basic data that define a content type | | Entando Content Template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | @@ -25,11 +25,13 @@ | Local Hub | The local component repository in an Entando App Builder | | Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | | Entando UX Fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | +| Entando Widget | A UI element that can be dragged and dropped onto a page, e.g. a snippet of HTML code added from the browser or a micro frontend, which is a specialized widget | ## General Technical Terms | Term | Description |:--|:-- +| application composition platform (ACP) | Any development platform that supports a catalog of packaged, composable components that can be assembled into applications, where changes to individual components proliferate to the assembly | | backend for frontend (BFF) | A type of microservice dedicated to a frontend that may also act as a facade to other enterprise microservices | | component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | | component collection | A packaged set of single components that are in some way functionally unrelated | From b6257408036d59bbce77bbbad32d8594d8d98dd9 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Tue, 15 Nov 2022 12:02:05 -0800 Subject: [PATCH 5/9] ENDOC-599 PR feedback --- vuepress/docs/next/docs/reference/glossary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index 40079f19e8..5d09b89804 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -5,13 +5,13 @@ | Term | Description |:--|:-- | Entando Application | An application running on the Entando Platform and available at a given URL | -| Entando App Builder | The frontend of the Entando Platform. Hosts the Entnado WCMS and provides the UI to interact with and configure Entando components. | +| Entando App Builder | The frontend of the Entando Platform. Hosts the Entando WCMS and provides the UI to interact with and configure Entando components. | | Entando App Engine | The core runtime engine for applications built with Entando App Builder. Provides the composition and rendering of the final application. | | Entando Bundle | A package built with Entando that contains one or more components | | Entando CLI (ent CLI) | Entando's core command line interface | | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | | Entando Component Generator (ECG) | An implementation of a JHipster blueprint that provides automation and templating to generate the components used to build an Entando Application | -| Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs contained in an Entando Bundle | +| Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs in an Entando Bundle | | Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | | Entando Content Type | The structure of specific content, defined by a set of content attributes | | Entando Content Attribute | The basic data that define a content type | @@ -37,7 +37,7 @@ | component collection | A packaged set of single components that are in some way functionally unrelated | | low-code | A software development approach that leverages visual interfaces with basic logic and drag-and-drop capabilities to build applications and processes | | micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | -| microservice | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | +| microservice (MS) | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | | module | A basic element partitioned into a system of building blocks (e.g. PBCs, components, bundles, templates) that are independent, reusable, and can easily be configured into complex and useful structures | | no-code | A programming platform on which applications are built exclusively using a visual development interface to drag and drop software components | | pro-code | The traditional coding technique that relies on complex programming languages to build products such as websites and software | From 552ff642e6f8c518ed09577553976e910c101b01 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Thu, 17 Nov 2022 12:29:15 -0800 Subject: [PATCH 6/9] ENDOC-599 Revisions and alignments --- vuepress/docs/next/docs/reference/glossary.md | 36 ++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index 5d09b89804..d65257c79c 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -4,43 +4,47 @@ | Term | Description |:--|:-- -| Entando Application | An application running on the Entando Platform and available at a given URL | -| Entando App Builder | The frontend of the Entando Platform. Hosts the Entando WCMS and provides the UI to interact with and configure Entando components. | -| Entando App Engine | The core runtime engine for applications built with Entando App Builder. Provides the composition and rendering of the final application. | -| Entando Bundle | A package built with Entando that contains one or more components | +| Entando Application | An application built with the Entando Platform and available at a given URL | +| Entando App Builder | The frontend of the Entando Platform that hosts the Entando WCMS and provides a feature-rich user interface to configure and interact with components, design and create pages, manage content and build applications | +| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, manages the cluster infrastructure and provides the data access layer to persist the page and application design | +| Entando Bundle | A packaged set of components and resources created on Entando | | Entando CLI (ent CLI) | Entando's core command line interface | | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | -| Entando Component Generator (ECG) | An implementation of a JHipster blueprint that provides automation and templating to generate the components used to build an Entando Application | -| Entando Component Manager (ECM) | Part of the ECR that coordinates the installation of the MFEs and MSs in an Entando Bundle | +| Entando Cluster | The infrastructure Entando deploys on Kubernetes via the Entando Operator and controllers; each discrete constituent is associated with a custom resource definition, if applicable | +| Entando Component Generator (ECG) | Entando's implementation of a JHipster blueprint that generates the components used to build an Entando Application via automation and templating | +| Entando Component Manager (ECM) | Provides functionality to build and organize micro frontends and widgets from within the App Builder and manages the connections between an application and the installed microservices | | Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | | Entando Content Type | The structure of specific content, defined by a set of content attributes | | Entando Content Attribute | The basic data that define a content type | | Entando Content Template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | -| Entando Digital Asset | Images, documents, and other media files supported in a specific format | -| Entando Hub | A repository (local, remote, public, or private) containing Entando components. A single Entando App Builder can connect to 1 or more Entando Hubs. | -| Entando Identity Management System | Entando's user management and authentication/authorization system, powered by Keycloak | -| Entando Kubernetes integration service (k8s-service) | Provides an abstraction layer between Entando microservices and the APIs exposed by a Kubernetes cluster | +| Entando Digital Asset | An image, document, or other media file that is uniquely identifiable and stored digitally in a format supported by the Entando Platform | +| Entando Hub | A repository (local, remote, public, or private) containing components built with the Entando Platform; A single Entando App Builder can connect to 1 or more Entando Hubs | +| Entando Identity Management | Entando's Keycloak- and token-based user management and authentication system | +| Entando Kubernetes integration service (k8s-service) | A function of the Entando Cluster infrastructure custom resource that provides an abstraction layer between Entando microservices and the APIs exposed by Kubernetes | +| Entando Local Hub | The local component repository in an Entando App Builder used to store and retrieve shareable components for reuse within an Entando Application | | Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | -| Entando Web Content Management System (WCMS) | Entando's web content management system | -| Local Hub | The local component repository in an Entando App Builder | +| Entando Platform | The leading open source application composition platform for development with a Kubernetes architecture | | Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | +| Entando Plugin | A microservice that exposes APIs reusable by one or more Entando Applications -- TODO: stand on its own or moved to MS def?? | | Entando UX Fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | +| Entando Web Content Management System (WCMS) | Entando's lightweight content and digital asset management system that supports headless operations | | Entando Widget | A UI element that can be dragged and dropped onto a page, e.g. a snippet of HTML code added from the browser or a micro frontend, which is a specialized widget | + ## General Technical Terms | Term | Description |:--|:-- -| application composition platform (ACP) | Any development platform that supports a catalog of packaged, composable components that can be assembled into applications, where changes to individual components proliferate to the assembly | +| application composition platform (ACP) | Any development platform that supports the cataloging and management of composable and packaged components, where new components can be added through custom development or imported from existing assets; it governs the life cycles of both the components and the applications built from their modular assembly and deployment | | backend for frontend (BFF) | A type of microservice dedicated to a frontend that may also act as a facade to other enterprise microservices | | component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | | component collection | A packaged set of single components that are in some way functionally unrelated | -| low-code | A software development approach that leverages visual interfaces with basic logic and drag-and-drop capabilities to build applications and processes | +| low-code | An application development platform that leverages visual interfaces equipped with basic logic and drag-and-drop capabilities to build products and processes | | micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | | microservice (MS) | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | | module | A basic element partitioned into a system of building blocks (e.g. PBCs, components, bundles, templates) that are independent, reusable, and can easily be configured into complex and useful structures | -| no-code | A programming platform on which applications are built exclusively using a visual development interface to drag and drop software components | -| pro-code | The traditional coding technique that relies on complex programming languages to build products such as websites and software | +| no-code | An application development platform that exclusively uses a visual development interface to drag and drop software components | +| pro-code | An application development platform that relies on complex programming languages to build products such as websites and software | From 9c8e7cadf75641829d331eb78d7687f9e84ab6fe Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Fri, 18 Nov 2022 10:04:01 -0800 Subject: [PATCH 7/9] ENDOC-599 Several tweaks --- vuepress/docs/next/docs/reference/glossary.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index d65257c79c..5343ef1a08 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -5,14 +5,14 @@ | Term | Description |:--|:-- | Entando Application | An application built with the Entando Platform and available at a given URL | -| Entando App Builder | The frontend of the Entando Platform that hosts the Entando WCMS and provides a feature-rich user interface to configure and interact with components, design and create pages, manage content and build applications | -| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, manages the cluster infrastructure and provides the data access layer to persist the page and application design | +| Entando App Builder | The frontend of the Entando Platform that hosts the Entando WCMS and provides a feature-rich user interface to configure and interact with components, design and create pages, manage content, and build applications | +| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, manages the cluster infrastructure, and provides the data access layer to persist the page and application design | | Entando Bundle | A packaged set of components and resources created on Entando | | Entando CLI (ent CLI) | Entando's core command line interface | | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | -| Entando Cluster | The infrastructure Entando deploys on Kubernetes via the Entando Operator and controllers; each discrete constituent is associated with a custom resource definition, if applicable | +| Entando Cluster | The infrastructure Entando deploys on Kubernetes via the Entando Operator and controllers; each element is associated with a custom resource definition, if applicable | | Entando Component Generator (ECG) | Entando's implementation of a JHipster blueprint that generates the components used to build an Entando Application via automation and templating | -| Entando Component Manager (ECM) | Provides functionality to build and organize micro frontends and widgets from within the App Builder and manages the connections between an application and the installed microservices | +| Entando Component Manager (ECM) | Provides functionality to build and organize micro frontends and widgets using the App Builder and manages the connections between an application and the installed microservices | | Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | | Entando Content Type | The structure of specific content, defined by a set of content attributes | | Entando Content Attribute | The basic data that define a content type | @@ -25,7 +25,7 @@ | Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | | Entando Platform | The leading open source application composition platform for development with a Kubernetes architecture | | Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | -| Entando Plugin | A microservice that exposes APIs reusable by one or more Entando Applications -- TODO: stand on its own or moved to MS def?? | +| Entando Plugin | A microservice that exposes APIs reusable by one or more Entando Applications | | Entando UX Fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | | Entando Web Content Management System (WCMS) | Entando's lightweight content and digital asset management system that supports headless operations | | Entando Widget | A UI element that can be dragged and dropped onto a page, e.g. a snippet of HTML code added from the browser or a micro frontend, which is a specialized widget | From 3dd100d3ce8b75065ed0b12c2fe1cc6b5c0534d7 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Fri, 18 Nov 2022 18:24:25 -0800 Subject: [PATCH 8/9] ENDOC-599 Apply PR feedback --- vuepress/docs/next/docs/reference/glossary.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/vuepress/docs/next/docs/reference/glossary.md b/vuepress/docs/next/docs/reference/glossary.md index 5343ef1a08..5f953e9af1 100644 --- a/vuepress/docs/next/docs/reference/glossary.md +++ b/vuepress/docs/next/docs/reference/glossary.md @@ -4,30 +4,30 @@ | Term | Description |:--|:-- -| Entando Application | An application built with the Entando Platform and available at a given URL | +| Entando Application | An application built with the Entando Platform | | Entando App Builder | The frontend of the Entando Platform that hosts the Entando WCMS and provides a feature-rich user interface to configure and interact with components, design and create pages, manage content, and build applications | -| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, manages the cluster infrastructure, and provides the data access layer to persist the page and application design | -| Entando Bundle | A packaged set of components and resources created on Entando | -| Entando CLI (ent CLI) | Entando's core command line interface | +| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, and provides the data access layer to persist the page and application design | +| Entando Bundle | A packaged set of components and resources created for the Entando Platform | +| Entando CLI (ent CLI) | Entando's command line interface | | Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | | Entando Cluster | The infrastructure Entando deploys on Kubernetes via the Entando Operator and controllers; each element is associated with a custom resource definition, if applicable | | Entando Component Generator (ECG) | Entando's implementation of a JHipster blueprint that generates the components used to build an Entando Application via automation and templating | -| Entando Component Manager (ECM) | Provides functionality to build and organize micro frontends and widgets using the App Builder and manages the connections between an application and the installed microservices | +| Entando Component Manager (ECM) | Provides functionality to deploy and install micro frontends and widgets using the App Builder and manages the connections between an application and the installed microservices | | Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | | Entando Content Type | The structure of specific content, defined by a set of content attributes | | Entando Content Attribute | The basic data that define a content type | | Entando Content Template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | | Entando Digital Asset | An image, document, or other media file that is uniquely identifiable and stored digitally in a format supported by the Entando Platform | | Entando Hub | A repository (local, remote, public, or private) containing components built with the Entando Platform; A single Entando App Builder can connect to 1 or more Entando Hubs | -| Entando Identity Management | Entando's Keycloak- and token-based user management and authentication system | +| Entando Identity Management | Entando's Keycloak-based user management and authentication system | | Entando Kubernetes integration service (k8s-service) | A function of the Entando Cluster infrastructure custom resource that provides an abstraction layer between Entando microservices and the APIs exposed by Kubernetes | -| Entando Local Hub | The local component repository in an Entando App Builder used to store and retrieve shareable components for reuse within an Entando Application | +| Entando Local Hub | The local component repository in an Entando App Builder representing the Entando Bundles deployed or installed in the Entando Application | | Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | | Entando Platform | The leading open source application composition platform for development with a Kubernetes architecture | | Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | | Entando Plugin | A microservice that exposes APIs reusable by one or more Entando Applications | -| Entando UX Fragment | An HTML block containing Freemarker tags that allow content to be rendered dynamically according to context | -| Entando Web Content Management System (WCMS) | Entando's lightweight content and digital asset management system that supports headless operations | +| Entando UX Fragment | An HTML block containing Freemarker tags that allows content to be rendered dynamically according to context | +| Entando Web Content Management System (WCMS) | Entando's lightweight content and digital asset management system | | Entando Widget | A UI element that can be dragged and dropped onto a page, e.g. a snippet of HTML code added from the browser or a micro frontend, which is a specialized widget | @@ -38,7 +38,7 @@ | application composition platform (ACP) | Any development platform that supports the cataloging and management of composable and packaged components, where new components can be added through custom development or imported from existing assets; it governs the life cycles of both the components and the applications built from their modular assembly and deployment | | backend for frontend (BFF) | A type of microservice dedicated to a frontend that may also act as a facade to other enterprise microservices | | component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | -| component collection | A packaged set of single components that are in some way functionally unrelated | +| component collection | A packaged set of single components | | low-code | An application development platform that leverages visual interfaces equipped with basic logic and drag-and-drop capabilities to build products and processes | | micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | | microservice (MS) | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | From 4afa22a242feaf0749bb5316691118fdd3fb0e7e Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Mon, 21 Nov 2022 11:02:19 -0800 Subject: [PATCH 9/9] ENDOC-599 Final touches (for now) --- vuepress/docs/.vuepress/next.js | 4 ++ vuepress/docs/.vuepress/v71.js | 4 ++ vuepress/docs/v7.1/docs/reference/glossary.md | 47 +++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 vuepress/docs/v7.1/docs/reference/glossary.md diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index f5a3bea562..937fa339d6 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -160,6 +160,10 @@ module.exports = { { title: 'Reference', children: [ + { + title: 'Entando Glossary', + path: path + 'reference/glossary.md' + }, { title: 'Deployment Structure', path: path + 'reference/deployment-structure.md' diff --git a/vuepress/docs/.vuepress/v71.js b/vuepress/docs/.vuepress/v71.js index aba8ea9c3f..3ab7319390 100644 --- a/vuepress/docs/.vuepress/v71.js +++ b/vuepress/docs/.vuepress/v71.js @@ -160,6 +160,10 @@ module.exports = { { title: 'Reference', children: [ + { + title: 'Entando Glossary', + path: path + 'reference/glossary.md' + }, { title: 'Deployment Structure', path: path + 'reference/deployment-structure.md' diff --git a/vuepress/docs/v7.1/docs/reference/glossary.md b/vuepress/docs/v7.1/docs/reference/glossary.md new file mode 100644 index 0000000000..75269a15b0 --- /dev/null +++ b/vuepress/docs/v7.1/docs/reference/glossary.md @@ -0,0 +1,47 @@ +# Entando Glossary + +## Entando Terms + +| Term | Description +|:--|:-- +| Entando Application | An application built with the Entando Platform | +| Entando App Builder | The frontend of the Entando Platform that hosts the Entando WCMS and provides a feature-rich user interface to configure and interact with components, design and create pages, manage content, and build applications | +| Entando App Engine | The core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications; it exposes the Entando App Builder APIs, assembles and coordinates components within the Entando App Builder, and provides the data access layer to persist the page and application design | +| Entando Bundle | A packaged set of components and resources created for the Entando Platform | +| Entando CLI (ent CLI) | Entando's command line interface | +| Entando Cloud Hub | A SaaS instance of an Entando Hub that contains a public and private collection of components | +| Entando Cluster | The infrastructure Entando deploys on Kubernetes via the Entando Operator and controllers; each element is associated with a custom resource definition, if applicable | +| Entando Component Generator (ECG) | Entando's implementation of a JHipster blueprint that generates the components used to build an Entando Application via automation and templating | +| Entando Component Manager (ECM) | Provides functionality to deploy and install micro frontends and widgets using the App Builder and manages the connections between an application and the installed microservices | +| Entando Content | A structured element representing a set of information built using Entando Content Attributes and added to an Entando Application via the Entando App Builder | +| Entando Content Type | The structure of specific content, defined by a set of content attributes | +| Entando Content Attribute | The basic data that define a content type | +| Entando Content Template | The style or layout of a content type where a single content type can have multiple content models defining different ways to render the same content | +| Entando Digital Asset | An image, document, or other media file that is uniquely identifiable and stored digitally in a format supported by the Entando Platform | +| Entando Hub | A repository (local, remote, public, or private) containing components built with the Entando Platform; A single Entando App Builder can connect to 1 or more Entando Hubs | +| Entando Identity Management | Entando's Keycloak-based user management and authentication system | +| Entando Kubernetes integration service (k8s-service) | A function of the Entando Cluster infrastructure custom resource that provides an abstraction layer between Entando microservices and the APIs exposed by Kubernetes | +| Entando Local Hub | The local component repository in an Entando App Builder representing the Entando Bundles deployed or installed in the Entando Application | +| Entando Operator | Provides installation and application lifecycle automation for Entando Applications, microservices and required infrastructure services, e.g. databases and Keycloak | +| Entando Platform | The leading open source application composition platform for development with a Kubernetes architecture | +| Entando Platform Capability (EPC) | A packaged capability that adds functionality to the platform and/or additional UX controls to the App Builder | +| Entando Plugin | A microservice that exposes APIs reusable by one or more Entando Applications | +| Entando UX Fragment | An HTML block containing Freemarker tags that allows content to be rendered dynamically according to context | +| Entando Web Content Management System (WCMS) | Entando's lightweight content and digital asset management system | +| Entando Widget | A UI element that can be dragged and dropped onto a page, e.g. a snippet of HTML code added from the browser or a micro frontend, which is a specialized widget | + + +## General Technical Terms + +| Term | Description +|:--|:-- +| application composition platform (ACP) | Any development platform that supports the cataloging and management of composable and packaged components, where new components can be added through custom development or imported from existing assets; it governs the life cycles of both the components and the applications built from their modular assembly and deployment | +| backend for frontend (BFF) | A type of microservice dedicated to a frontend that may also act as a facade to other enterprise microservices | +| component | An application building block such as a page template, content template, UX Fragment, widget, micro frontend, microservice, etc. | +| component collection | A packaged set of single components | +| low-code | An application development platform that leverages visual interfaces equipped with basic logic and drag-and-drop capabilities to build products and processes | +| micro frontend (MFE) | A web development approach that implements an architecture characterized by a composition of compact frontend applications | +| microservice (MS) | A software development technique characterized by an architecture of loosely coupled, granular services that employ lightweight protocols | +| module | A basic element partitioned into a system of building blocks (e.g. PBCs, components, bundles, templates) that are independent, reusable, and can easily be configured into complex and useful structures | +| no-code | An application development platform that exclusively uses a visual development interface to drag and drop software components | +| pro-code | An application development platform that relies on complex programming languages to build products such as websites and software | \ No newline at end of file