diff --git a/_templates/feature-integration-guide-template.md b/_templates/feature-integration-guide-template.md index 7332a21b0de..83456a2eab3 100644 --- a/_templates/feature-integration-guide-template.md +++ b/_templates/feature-integration-guide-template.md @@ -37,13 +37,10 @@ To start feature integration, integrate the required features and Glue APIs: ### 1) Install the required modules using Composer -Install the required modules: - ```bash {commands to install the required modules} ``` ---- **Verification** @@ -53,8 +50,6 @@ Make sure that the following modules have been installed: | ------------ | ---------------- | | {ModuleName} | {expected directory} | ---- - ### Set up the configuration @@ -93,7 +88,6 @@ console propel:install console transfer:generate ``` ---- **Verification** @@ -109,8 +103,6 @@ Make sure that the following changes have been triggered in transfer objects: | ---------- | ------ | ------- | ------ | | {transfer} | {type} | {event} | {path} | ---- - ### Set up database schema @@ -134,7 +126,6 @@ console propel:install console transfer:generate ``` ---- **Verification** @@ -144,13 +135,9 @@ Make sure that the following changes have been applied by checking your database | --------------- | ------ | ------- | | {entity} | {type} | {event} | ---- - ### Set up transfer objects - - Generate transfers: ```bash @@ -186,14 +173,11 @@ Add translations as follows: console data:import glossary ``` ---- **Verification** Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables. ---- - ### Configure export to Redis and Elasticsearch @@ -208,7 +192,6 @@ Configure tables to be published and synchronized to the Storage on create, edit {code snippet with plugin setup} ``` ---- **Verification** @@ -243,7 +223,6 @@ Configure tables to be published to the {table name} table and synchronized to t {code snippet with plugin setup} ``` ---- **Verification** @@ -294,9 +271,6 @@ Expected data fragment example: {expected data fragment example} ``` ---- - - ### Import data @@ -318,14 +292,11 @@ Import data as follows: {command to import data} ``` ---- **Verification** Make sure that the configured data has been added to the `{table_name}` table. ---- - #### Import infrastructural data @@ -347,14 +318,11 @@ Import infrastructural data as follows: console setup:init-db ``` ---- **Verification** Ensure that the {entities} have been added to the `{table_name}` table. ---- - #### Import {DataImporterName} @@ -366,7 +334,6 @@ Ensure that the {entities} have been added to the `{table_name}` table. {code snippet with plugin setup} ``` ---- **Verification** ---- - ### Set up behavior Enable the following behaviors by registering the plugins: @@ -388,15 +353,12 @@ Enable the following behaviors by registering the plugins: {code snippet with plugin setup} ``` ---- **Verification** ---- - ## Install feature frontend -Follow the steps below to install the {Feature Name} feature front end. +Follow the steps below to install the {Feature Name} feature frontend. ### Prerequisites @@ -417,7 +379,6 @@ Install the required modules: {command to install the required modules} ``` ---- **Verification** @@ -427,8 +388,6 @@ Make sure that the following modules have been installed: | ------------ | ----------------------------------------------- | | {ModuleName} | {expected directory} | ---- - ### Add translations Add translations as follows: @@ -445,7 +404,6 @@ Add translations as follows: console data:import glossary ``` ---- **Verification** @@ -466,12 +424,9 @@ Register the following route providers on the Storefront: {code snippet with provider setup} ``` ---- **Verification** ---- - ### Set up widgets @@ -505,10 +460,6 @@ Make sure that the following widgets have been registered by adding the respecti console frontend:yves:build ``` ---- - - - ## Related features Integrate the following related features and Glue APIs: diff --git a/_templates/glue-api-storefront-guide-template.md b/_templates/glue-api-storefront-guide-template.md index 41fdd84ef49..afbf6e133a2 100644 --- a/_templates/glue-api-storefront-guide-template.md +++ b/_templates/glue-api-storefront-guide-template.md @@ -49,7 +49,7 @@ If a particular combination of resources should be included in the request to ac --> -Request sample: {request description} (e.g. add an item to a shopping list) +Request sample: {request description} (e.g., add an item to a shopping list) '{method} {endpoint}{parameter example}' @@ -63,7 +63,7 @@ Request sample: {request description} (e.g. add an item to a shopping list) | {method} {endpoint}{parameter example} | | | {method} {endpoint}{parameter example}?include={included resource} | ```{language} diff --git a/_templates/howto-guide-template.md b/_templates/howto-guide-template.md index df01f0d43ed..a6d5cc46e9e 100644 --- a/_templates/howto-guide-template.md +++ b/_templates/howto-guide-template.md @@ -4,7 +4,7 @@ description: {Meta description} template: howto-guide-template --- -#{Title} +#{Title} {Overview} diff --git a/_templates/security-release-notes-template.md b/_templates/security-release-notes-template.md index 3c589a6fe91..b96eef24758 100644 --- a/_templates/security-release-notes-template.md +++ b/_templates/security-release-notes-template.md @@ -16,7 +16,7 @@ If you need any additional support with this content, [contact our support](mail {Description of the technical changes in the affected modules} - + ## Affected modules @@ -24,7 +24,6 @@ If you need any additional support with this content, [contact our support](mail - ## Introduced changes {Specify the modules and list changes made in them} diff --git a/_templates/troubleshooting-guide-template.md b/_templates/troubleshooting-guide-template.md index da294038e87..a2ee60e690f 100644 --- a/_templates/troubleshooting-guide-template.md +++ b/_templates/troubleshooting-guide-template.md @@ -14,7 +14,7 @@ Every troubleshooting article should have its own page in the respective section ## Title - + ## {Description}