ENDOC-599 Add a public lexicon/dictionary/index/glossary for Entando language #623
Conversation
|
|
||
| ## Entando Terms | ||
|
|
||
| ### Core Products |
There was a problem hiding this comment.
Let's simplify this a bit with an Entando Section, alpha-sorted (it's close now), and then General Technical Terms.
|
|
||
| | Term | Description | ||
| |:--|:-- | ||
| | Entando Platform | Comprises the complete set of software used to build Entando solutions, applications, sites or portals | |
There was a problem hiding this comment.
Move this to Entando section
| |:--|:-- | ||
| | Entando Platform | Comprises the complete set of software used to build Entando solutions, applications, sites or portals | | ||
|
|
||
| ### Solutions |
There was a problem hiding this comment.
Remove Solutions and Consulting Packages altogether. I don't think those are needed in a glossary since they are product/services specific.
| | 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 | |
There was a problem hiding this comment.
I think we can remove Entando Portal UI
| | 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 | |
There was a problem hiding this comment.
Maybe rename to "Entando Kubernetes integration service (k8s-service)"
| | 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 | |
There was a problem hiding this comment.
Lines 57-61 are not general terms, they are specific to Entando features, so either we remove or capitalize and move to the Entando section. The definition of Content needs to be tweaked if that's the case.
There was a problem hiding this comment.
@nshaw how should Content be clarified?
There was a problem hiding this comment.
@Lyd1aCla1r3 Maybe you can review the current Content section and also the training module re Content. https://developer.entando.com/v7.1/tutorials/compose/content-tutorial.html for one. I haven't found a standard definition, probably because "everyone knows what it is". :(
| | 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. | |
There was a problem hiding this comment.
Remove site template since we don't have great examples yet. Same for solution template.
| | 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 | |
There was a problem hiding this comment.
Move UX Fragment to Entando. I'm leaning towards keeping the Content*4 items to Entando as well.
| | 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 | |
There was a problem hiding this comment.
Remove WebUI - it was a partially completed alternative to PortalUI which has not yet been included in the platform.
|
|
||
| | Term | Description | ||
| |:--|:-- | ||
| | backend for frontend (BFF) | A software architecture pattern that connects the frontend of an application with the backend microservices | |
There was a problem hiding this comment.
Definition feels a little off. A BFF microservice is itself a microservice dedicated to a frontend. It may also act as a facade to other enterprise microservices.
|
|
||
| ## General Technical Terms | ||
|
|
||
| | Term | Description | ||
| |:--|:-- | ||
| | backend for frontend (BFF) | A software architecture pattern that connects the frontend of an application with the backend microservices | | ||
| | 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 | |
There was a problem hiding this comment.
proliferate to the assembly>> unclear what this means. language is fine but don't think this captures that things can be built.
changes to individual components proliferate to the assembly >> sounds like changes are just carried over, not that you can build applications on an ACP
There was a problem hiding this comment.
?? there is an assembly of components. changes to components proliferate to it. this says explicitly, using different forms of the same words for added clarity, that changes are carried over.
assemble = build. assembling components is how an acp builds an application.
| | 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 | |
There was a problem hiding this comment.
with a complex list like this with multiple ands, would consider a comma after every item in the list to keep it clear>> manage content, and build applications
same below in line 9
| | 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 | |
There was a problem hiding this comment.
discrete constituent >> vague and complicated
There was a problem hiding this comment.
yup yup... i have an issue with "citizens" tho (on agenda); not components, not citizens, "part" is weak... i'll keep thinking
There was a problem hiding this comment.
member! ...?? need to iron this out with nathan
| | 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 | |
There was a problem hiding this comment.
i actually think "using" or "via" is better... but "from within" connotes an action taking place in a specific location whereas "inside" just indicates a location; this is really splitting hairs but the one somehow seems more suitable. moot because action >> location
There was a problem hiding this comment.
also - i think this was pulled directly from a published page
| | 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 | |
There was a problem hiding this comment.
can a local hub be shared with anyone else?
There was a problem hiding this comment.
ugh. also on our agenda for today - pulled verbatim from a published page. and yeah i don't think so.
There was a problem hiding this comment.
How about "The local component repository in an Entando App Builder representing the Entando Bundles deployed or installed in the Entando Application"
| | 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?? | |
There was a problem hiding this comment.
didn't Nathan say to favor Microservices over plugin
There was a problem hiding this comment.
yes! this is on our agenda for today - it's a section on one of our main intro pages (note the TODO)
| ## 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 | |
There was a problem hiding this comment.
Any development platform that manages and catalogs composable packaged components ...
added through custom development or imported from existing assets >> added through custom development or imported << to simplify & assets have a specific meaning
it governs the life cycles of both the components and the applications built from their modular assembly and deployment >> it governs the life cycles of components and the applications built with them.
think it's ok to simplify here , it doesn't need to capture all the complexities.
There was a problem hiding this comment.
assets: from gartner. "imported" on its own is vague and ambiguous - needs to convey some sense of the source and constraints; "from an existing asset" -> a component can be derived as well as copied over in full (subtle info is valuable here)
the whole point of an acp is to enable modularity, both in the initial build and wrt updates; omitting this information takes away value. i agreed with your pov in our meeting that the more detail the better here, to make the definition clear and comprehensive. simplifying too much means someone has to look elsewhere to truly define and understand the term
There was a problem hiding this comment.
No strong opinion here. What we have is okay and I think it was approved by the team earlier?
|
| | 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 | |
There was a problem hiding this comment.
How about "The local component repository in an Entando App Builder representing the Entando Bundles deployed or installed in the Entando Application"
| ## 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 | |
There was a problem hiding this comment.
No strong opinion here. What we have is okay and I think it was approved by the team earlier?
|
|
||
| | Term | Description | ||
| |:--|:-- | ||
| | Entando Application | An application built with the Entando Platform and available at a given URL | |
There was a problem hiding this comment.
"available at a given URL" seems superfluous somehow
| |:--|:-- | ||
| | 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 | |
There was a problem hiding this comment.
We should remove "manages the cluster infrastructure". The Engine doesn't modify k8s.
| | 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 | |
There was a problem hiding this comment.
"on Entando" -> "for the Entando Platform"?
There was a problem hiding this comment.
i struggled with this... whether or not components/resources could be created externally to entando, then made to conform (for the entando platform) vs they needed to be created using the entando platform (on/with entando) - i.e. if a necessary conversion would mean the component/resource was created using entando, even if the conversion was a modification to something originally created elsewhere... thinking too much...
| | 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 | |
There was a problem hiding this comment.
"build and organize" -> "deploy and install"
| | 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 | |
There was a problem hiding this comment.
I would simplify to "Keycloak-based". Token implies OAuth but it's odd to include it here.
| | 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 | |
There was a problem hiding this comment.
block is singular so "that allow" -> "that allows"
There was a problem hiding this comment.
aha. i thought the tags were doing the allowing
| | 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 | |
There was a problem hiding this comment.
Let's remove "that supports headless operations". It has APIs but we don't want to compete with Strapi when we announce it, and our impl is rarely used headless.
| | 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 | |
There was a problem hiding this comment.
Remove "that are in some way functionally unrelated". There's no requirement that the components are or are not related.
There was a problem hiding this comment.
did i read this wrong? if not, do you know who originally wrote it, or can we just go ahead and change it without discussion
|
Just need to add 7.1 and put it in the nav. |
No description provided.