From 61f69320681bd7f7823fbb63ecc4fe203c7c12a2 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 12:50:46 +0200 Subject: [PATCH 01/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index ca4ea633..b6ff677c 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -198,25 +198,27 @@ Use the following resource properties to define the component: - isLayout + isBuildingBlock No boolean, false by default - Defines the component as a layout component. - Layout components are displayed in a separate section in the WebSight CMS pages editor from components that are not layout components.

+ Defines the component as a building block component. + Building block components are displayed in a separate section in the WebSight CMS pages editor from components that are not building block components.

- It’s up to the component developer to set isLayout=true, but the guideline is to use it for components that:
- - are used to define page layout
+ It’s up to the component developer to set isBuildingBlock=true, but the guideline is to use it for components that:
+ - are used to speed up page content creation process
+ - create components instances in specific layout and initial setup
- must contain other components to be usable
- contain no logic (other than logic related to layout calculation)
- interact only on page resize (no other “user actions” allowed)
- have no visible UI elements (like texts)

- Examples of Layouts:
- - 2-column container
- - 1-column container
+ Examples of building block:
+ - Hero sections (containers including texts, images, etc dedicated to be used at the top section of the page)
+ - 4 columns paragraph (container including title and containers for 4 columns with title + RTE in each)
- Section with title, image, text and CTA (container including components)

Example of components that are not Layouts:
+ - 2-columns, 3-columens, etc, empty containers setup - containers should contain components allowing to set content to be useful building block
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
- Accordion, which contains logic not related to layout calculation
From a9a07923a7fe99f392888edb069538da8f1be0e6 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:03:59 +0200 Subject: [PATCH 02/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index b6ff677c..d1634c8d 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -210,8 +210,11 @@ Use the following resource properties to define the component: - must contain other components to be usable
- contain no logic (other than logic related to layout calculation)
- interact only on page resize (no other “user actions” allowed)
+ - have no visible UI elements (like texts)
- have no visible UI elements (like texts)

+ To implement a building block component use the instanceResourceType component definition property and define the component template.

+ Examples of building block:
- Hero sections (containers including texts, images, etc dedicated to be used at the top section of the page)
- 4 columns paragraph (container including title and containers for 4 columns with title + RTE in each)
From 9e856212eba2ff425e357226c107f0014509e867 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:08:09 +0200 Subject: [PATCH 03/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index d1634c8d..7f9e3275 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -221,7 +221,7 @@ Use the following resource properties to define the component: - Section with title, image, text and CTA (container including components)

Example of components that are not Layouts:
- - 2-columns, 3-columens, etc, empty containers setup - containers should contain components allowing to set content to be useful building block
+ - 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
- Accordion, which contains logic not related to layout calculation
From 93a73deb94a1879e0c07f2a8cacee4135107826a Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:21:34 +0200 Subject: [PATCH 04/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index 7f9e3275..7abfd560 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -209,8 +209,7 @@ Use the following resource properties to define the component: - create components instances in specific layout and initial setup
- must contain other components to be usable
- contain no logic (other than logic related to layout calculation)
- - interact only on page resize (no other “user actions” allowed)
- - have no visible UI elements (like texts)
+ - interact only on page resize (no other “user actions” allowed)
- have no visible UI elements (like texts)

To implement a building block component use the instanceResourceType component definition property and define the component template.

From 248caa384e25f4a8c5a5cbff2022e48f5d44b8f3 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:22:02 +0200 Subject: [PATCH 05/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index 7abfd560..a879d1c2 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -219,7 +219,7 @@ Use the following resource properties to define the component: - 4 columns paragraph (container including title and containers for 4 columns with title + RTE in each)
- Section with title, image, text and CTA (container including components)

- Example of components that are not Layouts:
+ Example of components that are not building block:
- 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
From 0658c2ef25c458e62d320d5ff297cf575dc0685b Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:22:17 +0200 Subject: [PATCH 06/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index a879d1c2..d95772cc 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -219,7 +219,7 @@ Use the following resource properties to define the component: - 4 columns paragraph (container including title and containers for 4 columns with title + RTE in each)
- Section with title, image, text and CTA (container including components)

- Example of components that are not building block:
+ Example of components that are not building blocks:
- 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
From 6fb83080ad7775df4e9d1fb303e26832e11a1247 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:54:42 +0200 Subject: [PATCH 07/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index d95772cc..5cc7804d 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -204,7 +204,7 @@ Use the following resource properties to define the component: Defines the component as a building block component. Building block components are displayed in a separate section in the WebSight CMS pages editor from components that are not building block components.

- It’s up to the component developer to set isBuildingBlock=true, but the guideline is to use it for components that:
+ It’s up to the component developer to set isBuildingBlock=true, but the guideline is to use it for components that:
- are used to speed up page content creation process
- create components instances in specific layout and initial setup
- must contain other components to be usable
@@ -212,15 +212,17 @@ Use the following resource properties to define the component: - interact only on page resize (no other “user actions” allowed)
- have no visible UI elements (like texts)

- To implement a building block component use the instanceResourceType component definition property and define the component template.

+ Name of the building block should be describing the usage, like 'Hero section' for container including texts, images, etc dedicated to be used at the top section of the page.
+ To implement a building block component use the instanceResourceType component definition property and define the component template. + The building block component should not provide it's own rendering script or dialog.

Examples of building block:
- - Hero sections (containers including texts, images, etc dedicated to be used at the top section of the page)
- - 4 columns paragraph (container including title and containers for 4 columns with title + RTE in each)
- - Section with title, image, text and CTA (container including components)

- + - containers including texts, images, etc dedicated to be used at the top section of the page
+ - container including title and containers for 4 columns with title + RTE in each
+ - Section with title, image, text and CTA (container including components)
+ Example of components that are not building blocks:
- - 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block
+ - 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block - components like that which are also using instanceResourceType component definition and define the component template, without own rendering script should not be marked as building block and should be present in Editor components section
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
- Accordion, which contains logic not related to layout calculation
From 027b40d0a19fdfd982ece92b2edee93361298ba9 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 13:59:24 +0200 Subject: [PATCH 08/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index 5cc7804d..0fdef4a5 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -222,7 +222,7 @@ Use the following resource properties to define the component: - Section with title, image, text and CTA (container including components)
Example of components that are not building blocks:
- - 2-columns, 3-columens, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block - components like that which are also using instanceResourceType component definition and define the component template, without own rendering script should not be marked as building block and should be present in Editor components section
+ - 2-columns, 3-columns, empty section, empty containers setup, etc - containers and sections should contain components allowing to set content to be useful building block - components like that which are also using instanceResourceType component definition and define the component template, without own rendering script should not be marked as building block and should be present in Editor components section
- image, title or CTA, all of which have visible UI elements (like texts)
- logo cloud, which contain very specific CSS logic and should not be used to create generic page layouts)
- Accordion, which contains logic not related to layout calculation
From e1b761fc848551e19f55863c100153f170acd6ec Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 14:00:59 +0200 Subject: [PATCH 09/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index 0fdef4a5..7e0d4708 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -206,7 +206,7 @@ Use the following resource properties to define the component: It’s up to the component developer to set isBuildingBlock=true, but the guideline is to use it for components that:
- are used to speed up page content creation process
- - create components instances in specific layout and initial setup
+ - create components instances allowing to set the content in specific layout and initial setup
- must contain other components to be usable
- contain no logic (other than logic related to layout calculation)
- interact only on page resize (no other “user actions” allowed)
From 68c14f129dee8111e5b5cf44d228fa3e57b7f2d5 Mon Sep 17 00:00:00 2001 From: Pawel Boguski Date: Tue, 4 Jul 2023 14:04:21 +0200 Subject: [PATCH 10/10] layouts renamed to building blocks --- docs/cms/developers/components/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cms/developers/components/index.md b/docs/cms/developers/components/index.md index 7e0d4708..ac12a9e6 100644 --- a/docs/cms/developers/components/index.md +++ b/docs/cms/developers/components/index.md @@ -207,14 +207,14 @@ Use the following resource properties to define the component: It’s up to the component developer to set isBuildingBlock=true, but the guideline is to use it for components that:
- are used to speed up page content creation process
- create components instances allowing to set the content in specific layout and initial setup
- - must contain other components to be usable
+ - must use other components to be usable
- contain no logic (other than logic related to layout calculation)
- interact only on page resize (no other “user actions” allowed)
- have no visible UI elements (like texts)

Name of the building block should be describing the usage, like 'Hero section' for container including texts, images, etc dedicated to be used at the top section of the page.
To implement a building block component use the instanceResourceType component definition property and define the component template. - The building block component should not provide it's own rendering script or dialog.

+ The building block component should not provide it own rendering script or dialog.

Examples of building block:
- containers including texts, images, etc dedicated to be used at the top section of the page