From 104c00a74f0f8e80f389c6884430ac7b6d9e137a Mon Sep 17 00:00:00 2001 From: Mariana-Caetano Date: Mon, 27 Mar 2023 09:43:29 -0300 Subject: [PATCH 1/4] New doc - onlySettings --- ...onlySettings property in a content type.md | 41 +++++++++++++++++++ .../Using onlySettings property.md | 41 +++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property in a content type.md create mode 100644 docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md diff --git a/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property in a content type.md b/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property in a content type.md new file mode 100644 index 000000000..3ca5be8a0 --- /dev/null +++ b/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property in a content type.md @@ -0,0 +1,41 @@ +# Using onlySettings property in a content type + +The `onlySetting` property indicates that a [content type](https://www.faststore.dev/tutorials/cms-storecomponents/0#content-types) is meant for settings only. + +For instance, you might use this attribute for content types that do not require storefront content, such as an SEO page. + +| Image 1 | Image 2 | +|---|---| +| ![without-property](https://user-images.githubusercontent.com/67270558/227936062-02e15860-c6d6-4525-9eed-19c37abfd626.png) | ![with-property](https://user-images.githubusercontent.com/67270558/227936232-fa8dfab7-2f01-42d1-9f68-b2ab8623a3af.png) | +| Image 1 - Content type without `onlySettings` and with two tabs: **Sections** and **SEO**. | Image 2 - Content type with `onlySettings` and with one tab for settings: **SEO**. | + +This property ensures that the content type's page displays only the available settings without the **Section** tab. +Follow the steps below to use the `onlySettings` property for your desired content type. + +## Step-by-step +1. Go to the store's repository and access ` CMS` > `content-types.json`. +2. Choose your desired content type and add the `onlySettings` property as `true`. For example: + +```json + { + "id": "SEO", + "name": "Global SEO Settings", + "onlySettings": true, + "configurationSchemaSets": [ + { + "name": "SEO", + "configurations": [ + ... + ] + } + ] + } +``` + +3. Sync your changes in the `CMS` folder by running the following command: + +```bash +vtex cms sync +``` + +After syncing your changes, go to your store's Admin and select **Storefront > Headless CMS**. Then, navigate to the content type to which you added the property and ensure the only tab available is for settings. diff --git a/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md b/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md new file mode 100644 index 000000000..3ca5be8a0 --- /dev/null +++ b/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md @@ -0,0 +1,41 @@ +# Using onlySettings property in a content type + +The `onlySetting` property indicates that a [content type](https://www.faststore.dev/tutorials/cms-storecomponents/0#content-types) is meant for settings only. + +For instance, you might use this attribute for content types that do not require storefront content, such as an SEO page. + +| Image 1 | Image 2 | +|---|---| +| ![without-property](https://user-images.githubusercontent.com/67270558/227936062-02e15860-c6d6-4525-9eed-19c37abfd626.png) | ![with-property](https://user-images.githubusercontent.com/67270558/227936232-fa8dfab7-2f01-42d1-9f68-b2ab8623a3af.png) | +| Image 1 - Content type without `onlySettings` and with two tabs: **Sections** and **SEO**. | Image 2 - Content type with `onlySettings` and with one tab for settings: **SEO**. | + +This property ensures that the content type's page displays only the available settings without the **Section** tab. +Follow the steps below to use the `onlySettings` property for your desired content type. + +## Step-by-step +1. Go to the store's repository and access ` CMS` > `content-types.json`. +2. Choose your desired content type and add the `onlySettings` property as `true`. For example: + +```json + { + "id": "SEO", + "name": "Global SEO Settings", + "onlySettings": true, + "configurationSchemaSets": [ + { + "name": "SEO", + "configurations": [ + ... + ] + } + ] + } +``` + +3. Sync your changes in the `CMS` folder by running the following command: + +```bash +vtex cms sync +``` + +After syncing your changes, go to your store's Admin and select **Storefront > Headless CMS**. Then, navigate to the content type to which you added the property and ensure the only tab available is for settings. From dd753c0f8f4281ec33c67626fe41982e404e2ca6 Mon Sep 17 00:00:00 2001 From: Mariana-Caetano Date: Mon, 27 Mar 2023 09:43:51 -0300 Subject: [PATCH 2/4] renamed doc --- .../Using onlySettings property.md | 41 ------------------- 1 file changed, 41 deletions(-) delete mode 100644 docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md diff --git a/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md b/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md deleted file mode 100644 index 3ca5be8a0..000000000 --- a/docs/how-to-guides/cms/vtex-headless-cms/Using onlySettings property.md +++ /dev/null @@ -1,41 +0,0 @@ -# Using onlySettings property in a content type - -The `onlySetting` property indicates that a [content type](https://www.faststore.dev/tutorials/cms-storecomponents/0#content-types) is meant for settings only. - -For instance, you might use this attribute for content types that do not require storefront content, such as an SEO page. - -| Image 1 | Image 2 | -|---|---| -| ![without-property](https://user-images.githubusercontent.com/67270558/227936062-02e15860-c6d6-4525-9eed-19c37abfd626.png) | ![with-property](https://user-images.githubusercontent.com/67270558/227936232-fa8dfab7-2f01-42d1-9f68-b2ab8623a3af.png) | -| Image 1 - Content type without `onlySettings` and with two tabs: **Sections** and **SEO**. | Image 2 - Content type with `onlySettings` and with one tab for settings: **SEO**. | - -This property ensures that the content type's page displays only the available settings without the **Section** tab. -Follow the steps below to use the `onlySettings` property for your desired content type. - -## Step-by-step -1. Go to the store's repository and access ` CMS` > `content-types.json`. -2. Choose your desired content type and add the `onlySettings` property as `true`. For example: - -```json - { - "id": "SEO", - "name": "Global SEO Settings", - "onlySettings": true, - "configurationSchemaSets": [ - { - "name": "SEO", - "configurations": [ - ... - ] - } - ] - } -``` - -3. Sync your changes in the `CMS` folder by running the following command: - -```bash -vtex cms sync -``` - -After syncing your changes, go to your store's Admin and select **Storefront > Headless CMS**. Then, navigate to the content type to which you added the property and ensure the only tab available is for settings. From 53f0c1c5c10124b3c4c24c6ce754545879fe5f3e Mon Sep 17 00:00:00 2001 From: Mariana-Caetano Date: Mon, 27 Mar 2023 13:40:19 -0300 Subject: [PATCH 3/4] Added onlySettings release note --- blog/2023-03-30-cms.md | 27 +++++++++++++++++++++++++++ static/data/releases.json | 7 +++++++ 2 files changed, 34 insertions(+) create mode 100644 blog/2023-03-30-cms.md diff --git a/blog/2023-03-30-cms.md b/blog/2023-03-30-cms.md new file mode 100644 index 000000000..907b8508a --- /dev/null +++ b/blog/2023-03-30-cms.md @@ -0,0 +1,27 @@ +---- +title: "New property for creating setting-only content types" +description: "Create settings-only content types with the new `onlySettings` property, ideal for non-storefront content like SEO pages." +tags: [cms] +--- + +The `onlySettings` property is now available for merchants to create content types intended for settings only. ​​This option is particularly useful for content types that do not require storefront content, like an SEO page. + +| Image 1 | Image 2 | +|---|---| +| ![without-property](https://user-images.githubusercontent.com/67270558/227936062-02e15860-c6d6-4525-9eed-19c37abfd626.png) | ![with-property](https://user-images.githubusercontent.com/67270558/227936232-fa8dfab7-2f01-42d1-9f68-b2ab8623a3af.png) | +| Image 1 - Content type without `onlySettings` and with two tabs: **Sections** and **SEO**. | Image 2 - Content type with `onlySettings` and with one tab for settings: **SEO**. | + +This property ensures that the content type's page displays only the available settings without the **Section** tab. +Follow the steps below to use the `onlySettings` property for your desired content type. + +## What has changed? + +Previously, when creating or editing a settings-only content type, there were two tabs on the page: one for sections and one for page settings. However, for some content types like SEO, which do not have storefront content, the Sections tab was not relevant. + +Now, the `onlySettings` property allows the creation of content types meant for settings only. This change improves content management and improves interface navigation for merchants by displaying only one configuration tab on the page. + +## Why are we making this change? +The change enables the creation of setting-only content types that do not require storefront content and simplifies interface navigation by displaying only one tab for the page configuration. + +## What needs to be done? +Follow the instructions in [Using `onlySettings` property in a content type]() documentation and add the property to your store. \ No newline at end of file diff --git a/static/data/releases.json b/static/data/releases.json index 6101ed7b6..2a68aa367 100644 --- a/static/data/releases.json +++ b/static/data/releases.json @@ -1,4 +1,11 @@ [ + + { + "title": "New property for creating setting-only content types", + "product": "CMS", + "fileName": "2023-03-30-cms", + "description": "Create settings-only content types with the new onlySettings property, ideal for non-storefront content like SEO pages." + }, { "title": "New Calendar Views to manage Releases", "product": "CMS", From cd0c5884bedb8dd2ce43b5ab2ac23dd70d357c9a Mon Sep 17 00:00:00 2001 From: Mariana Caetano Pereira <67270558+Mariana-Caetano@users.noreply.github.com> Date: Mon, 27 Mar 2023 13:49:40 -0300 Subject: [PATCH 4/4] Update blog/2023-03-30-cms.md --- blog/2023-03-30-cms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/blog/2023-03-30-cms.md b/blog/2023-03-30-cms.md index 907b8508a..644ef1955 100644 --- a/blog/2023-03-30-cms.md +++ b/blog/2023-03-30-cms.md @@ -24,4 +24,4 @@ Now, the `onlySettings` property allows the creation of content types meant for The change enables the creation of setting-only content types that do not require storefront content and simplifies interface navigation by displaying only one tab for the page configuration. ## What needs to be done? -Follow the instructions in [Using `onlySettings` property in a content type]() documentation and add the property to your store. \ No newline at end of file +Follow the instructions in [Using `onlySettings` property in a content type](/tbd) documentation and add the property to your store. \ No newline at end of file