Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct templates #1929

Merged
merged 5 commits into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 1 addition & 50 deletions _templates/feature-integration-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,10 @@ To start feature integration, integrate the required features and Glue APIs:
### 1) Install the required modules using Composer
<!--Provide one or more console commands with the exact latest version numbers of all required modules. If the Composer command contains the modules that are not related to the current feature, move them to the [prerequisites](#prerequisites).-->

Install the required modules:

```bash
{commands to install the required modules}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Expand All @@ -53,8 +50,6 @@ Make sure that the following modules have been installed:
| ------------ | ---------------- |
| {ModuleName} | {expected directory} |

---

### Set up the configuration
<!--Describe system and module configuration changes. If the default configuration is enough for a primary behavior, skip this step.-->

Expand Down Expand Up @@ -93,7 +88,6 @@ console propel:install
console transfer:generate
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Expand All @@ -109,8 +103,6 @@ Make sure that the following changes have been triggered in transfer objects:
| ---------- | ------ | ------- | ------ |
| {transfer} | {type} | {event} | {path} |

---

### Set up database schema
<!--If the feature has transfer object definition changes, merge the steps as described in [Set up database schema and transfer objects](#set-up-database-schema-and-transfer-objects). Provide code snippets with DB schema changes, describing the changes before each code snippet. Provide the console commands to apply the changes in project and core. -->

Expand All @@ -134,7 +126,6 @@ console propel:install
console transfer:generate
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Expand All @@ -144,13 +135,9 @@ Make sure that the following changes have been applied by checking your database
| --------------- | ------ | ------- |
| {entity} | {type} | {event} |

---

### Set up transfer objects
<!--If the feature has database definition changes, merge the steps as described in [Set up database schema and transfer objects](#set-up-database-schema-and-transfer-objects). Provide code snippet with transfer schema changes, describing the changes before each code snippet. Provide the console commands to apply the changes in project and core.-->



Generate transfers:

```bash
Expand Down Expand Up @@ -186,14 +173,11 @@ Add translations as follows:
console data:import glossary
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

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
<!--Provide the plugins for wiring P&S up. Provide the plugins for enabling re-generate and re-sync features of P&S.-->

Expand All @@ -208,7 +192,6 @@ Configure tables to be published and synchronized to the Storage on create, edit
{code snippet with plugin setup}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.

Expand All @@ -226,9 +209,6 @@ Expected data fragment example:
{expected data fragment example}
```

---


### Configure export to Redis
<!--If the feature has Elasticsearch configuration changes, merge the steps as described in [Configure export to Redis and Elasticsearch](#configure-export-to-redis-and-elasticsearch). Provide the plugins for wiring P&S up. Provide the plugins for enabling re-generate and re-sync features of P&S.-->

Expand All @@ -243,7 +223,6 @@ Configure tables to be published to the {table name} table and synchronized to t
{code snippet with plugin setup}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.

Expand All @@ -261,8 +240,6 @@ Expected data fragment example: {target entity}
{expected data fragment example}
```

---

#### Configure export to Elasticsearch
<!--If the feature has Redis configuration changes, merge the steps as described in [Configure export to Redis and Elasticsearch](#configure-export-to-redis-and-elasticsearch). Provide a plugin list for wiring P&S up. Provide a plugin list for enabling Re-generate and Re-sync features of P&S.-->

Expand Down Expand Up @@ -294,9 +271,6 @@ Expected data fragment example:
{expected data fragment example}
```

---


### Import data
<!--This section contains as many sub-sections as many data importers the feature has; additionally, infrastructural importers appear here.-->

Expand All @@ -318,14 +292,11 @@ Import data as follows:
{command to import data}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Make sure that the configured data has been added to the `{table_name}` table.

---

#### Import infrastructural data
<!--Provide the plugin list for wiring up the installation of infrastructural data. Provide the console command to run the installation of the infrastructural data.-->

Expand All @@ -347,14 +318,11 @@ Import infrastructural data as follows:
console setup:init-db
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly. Provide verification for "Configure Export to Redis and Elasticsearch".-->

Ensure that the {entities} have been added to the `{table_name}` table.

---

#### Import {DataImporterName}
<!--Provide demo data for the current data importer as a code snippet. Provide additional information about glossary key generation if it depends on data import. Provide a table with data import column definitions. Provide the plugin list to wire up the data importer. Provide a code snippet showing how to attach the data import to a console command. Provide the console command to import data.-->

Expand All @@ -366,16 +334,13 @@ Ensure that the {entities} have been added to the `{table_name}` table.
{code snippet with plugin setup}
```

---
**Verification**
<!--Describe how a developer can check that they have completed the following steps correctly:
* Current step
* [Configure Export to Redis and Elasticsearch](#configure-export-to-redis-and-elasticsearch)
* [Configure Export to Elasticsearch](#configure-export-to-elasticsearch)
* [Configure Export to Redis](#configure-export-to-redis) -->

---

### Set up behavior
<!--This is a comment, it will not be included -->
Enable the following behaviors by registering the plugins:
Expand All @@ -388,15 +353,12 @@ Enable the following behaviors by registering the plugins:
{code snippet with plugin setup}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

---

## 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
<!--Describe the features the project must have before the current feature can be integrated.-->
Expand All @@ -417,7 +379,6 @@ Install the required modules:
{command to install the required modules}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Expand All @@ -427,8 +388,6 @@ Make sure that the following modules have been installed:
| ------------ | ----------------------------------------------- |
| {ModuleName} | {expected directory} |

---

### Add translations

Add translations as follows:
Expand All @@ -445,7 +404,6 @@ Add translations as follows:
console data:import glossary
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

Expand All @@ -466,12 +424,9 @@ Register the following route providers on the Storefront:
{code snippet with provider setup}
```

---
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

---

### Set up widgets
<!--Provide a list of plugins and global widgets to enable widgets. Add descriptions for complex javascript code snippets. Provide a console command for generating front-end code.-->

Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions _templates/glue-api-storefront-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}' <!--usage description (in imperative mood, i.e. Retrieve all products).-->

Expand All @@ -63,7 +63,7 @@ Request sample: {request description} (e.g. add an item to a shopping list)
| {method} {endpoint}{parameter example} | <!-- usage description (in imperative mood, i.e. Retrieve all products) --> |
| {method} {endpoint}{parameter example}?include={included resource} | <!-- If including a resource into a request requires other resources to be included, describe only the target resource. For example, including `bundled-products` requires `concrete-products` and `bundled-products`. In this case, describe the request as " Retrieve ... with bundled products" omitting the other two resources. |

<details><summary markdown='span'>Request sample: {request description} (e.g. add an item to a shopping list)</summary>
<details><summary markdown='span'>Request sample: {request description} (e.g., add an item to a shopping list)</summary>
'{method} {endpoint}{parameter example}' <!--usage description (in imperative mood, i.e. Retrieve all products). -->

```{language}
Expand Down
2 changes: 1 addition & 1 deletion _templates/howto-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: {Meta description}
template: howto-guide-template
---

#{Title} <!---in -ing form, e.g. Creating CMS pages)-->
#{Title} <!---in -ing form, e.g., Creating CMS pages)-->

{Overview}
<!---Help the readers to determine quickly if the HowTo matches their interests or needs. In a few sentences, summarize the main points of your HowTo. Make sure to include any critical definitions which will help readers evaluate the utility of your HowTo.-->
Expand Down
3 changes: 1 addition & 2 deletions _templates/security-release-notes-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@ If you need any additional support with this content, [contact our support](mail

{Description of the technical changes in the affected modules}

<!-- Description example: Administrators can place a malicious payload in placeholders, which can be executed while trying to save, preview, or view the new page, resulting in an XSS vulnerability.. -->
<!-- Description example: Administrators can place a malicious payload in placeholders, which can be executed while trying to save, preview, or view the new page, resulting in an XSS vulnerability. -->

## Affected modules

{module}: {version} <!--Example: `spryker/propel`: 1.0.0-3.37.0-->

<!-- Link the module with the version to the respective release tag page on GitHub—for example, "[spryker/comment 1.1.0.](https://github.com/spryker/comment/releases/tag/1.1.0)" -->


## Introduced changes

{Specify the modules and list changes made in them}
Expand Down
2 changes: 1 addition & 1 deletion _templates/troubleshooting-guide-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Every troubleshooting article should have its own page in the respective section

## Title

<!-- Summary of the issue, e.g. Unable to resolve hosts for RabbitMq -->
<!-- Summary of the issue, e.g., Unable to resolve hosts for RabbitMq -->

## {Description}

Expand Down