diff --git a/vuepress/docs/next/docs/curate/bundle-component-details.md b/vuepress/docs/next/docs/curate/bundle-component-details.md index 4857dc959e..e72a06b928 100644 --- a/vuepress/docs/next/docs/curate/bundle-component-details.md +++ b/vuepress/docs/next/docs/curate/bundle-component-details.md @@ -5,15 +5,15 @@ sidebarDepth: 2 # Bundle Component Descriptors -Elements such as pages, content, simple widgets, fragments, and static resources are classified as platform components on Entando. This page describes each of these elements with an example. +Elements such as pages, content, simple widgets, fragments, and static resources that belong to a bundle are classified as platform components on Entando. The following paragraphs describe each of these types and how they can be used in a bundle, with an example. Currently, Entando supports the following component types: ![component-types.png](./img/component-types.png) -Each component is defined by a descriptor YAML located in the bundle `platform` directory, inside the corresponding type as listed below. During the bundle pack phase, the descriptors are added to build the Docker images for the bundle. +Each is defined by a descriptor YAML placed in the corresponding folder inside the bundle `platform` directory. During the pack phase of building an Entando bundle, the descriptors are included in the resulting Docker image following this pattern. -Here is an example structure of a bundle project: +Here is an example structure of the `platform` directory in an Entando Bundle project: ``` bundle-project/ @@ -39,7 +39,7 @@ bundle-project/ ... entando.json <= Bundle project descriptor ``` ->Note: Older names `pageModels` and `contentModels` for `pageTemplates` and `contentTemplates`, respectively, are still supported on Entando 7 but may be removed in a future release. +>Note: Older names `pageModels` and `contentModels`, for `pageTemplates` and `contentTemplates` respectively, are still supported on Entando 7 but may be phased out in future releases. ## Assets The CMS asset descriptor contains the metadata required for uploading and updating bundle assets. @@ -69,7 +69,9 @@ This descriptor contains a list of categories. ## Contents This descriptor enables content to be created and published via a bundle, according to the `status` property. The content ID is optional and enables linking from other components, like content widgets. It can be auto-generated or explicitly declared. -Groups in a content descriptor are configured by the owner group `mainGroup` and the join group `groups`. The owner group consists of users who can manage the content within the App Builder, while the join group consists of users who can view the content. +Groups in a content descriptor are configured by the owner group `mainGroup` and the join group, `groups`. The owner group consists of users who can manage the content within the App Builder, while the join group consists of users who can view the content. + +See an example of [how content is created and managed](../../tutorials/compose/content-tutorial.md). **contents-descriptor.yaml** @@ -93,7 +95,9 @@ Groups in a content descriptor are configured by the owner group `mainGroup` and - code: body values: en: | -
For many people, financial concerns are their number one stress point. Here are 6 ways to help reduce your money stress and get motivated to take control of your finances.
+For many people, financial concerns are their number one stress point. + Here are 6 ways to help reduce your money stress and get motivated + to take control of your finances.
- code: img values: en: @@ -126,11 +130,12 @@ Groups in a content descriptor are configured by the owner group `mainGroup` and correlationCode: '205' name: Entando_Admin_Console_Overview_4.3.3_EN.pdf -**^ Content Links** -* Content descriptors are loaded in alphabetical order during the bundle creation process. If content X references content Y, content Y must already exist in the bundle for the reference to work. To guarantee referential integrity in a bundle, we recommend that the descriptor name for Y appears earlier in the alphabetical order then content X. -* Contents in bundles cannot make circular references to another content through the link attribute. A circular link is when content A links to content B and B links back to A. Due to the descriptor's alphabetical order of installation, the circular link will cause an error but the links can be added manually after the installation of the bundle. +**^ Code: Links** +* Content descriptors are loaded in alphabetical order during the bundle creation process. If content X references content Y, content Y must already exist in the bundle for the reference to work. To guarantee referential integrity in a bundle, we recommend that the descriptor name for Y appear earlier in the alphabetical order then content X. +* Content in bundles cannot make circular references to each other through the link attribute. A circular link is when content A links to content B and B links back to A. Due to the descriptor's alphabetical order of installation, the circular link will cause an error, but the links can be added manually after the installation of the bundle. ## Content Templates +For some additional details, see the [Content Templates Tutorial](../../tutorials/compose/content-templates-tutorial.md). **contentTemplates-descriptor.yaml** @@ -138,10 +143,12 @@ Groups in a content descriptor are configured by the owner group `mainGroup` and contentType: CNG description: Demo Content Template - # Optional. Define the content template shape in a separate file or inside the descriptor file with `contentShape` + # Optional. Define the content template shape in a separate file or inside + # the descriptor file with `contentShape` contentShapePath: - # Optional. Define the content template shape as shown below or in a separate file with `contentShapePath` + # Optional. Define the content template shape as shown below or in a separate file + # with `contentShapePath` contentShape: >-