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.

Sign up for GitHub

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

Adding notes to IG guide template #2446

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Adding notes to IG guide template #2446

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
116 changes: 114 additions & 2 deletions _templates/feature-installation-guide-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,23 @@ Install 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).-->

<!--When "composer require" includes a "Spryker Feature" (github.com/spryker-feature), then it always needs to be "dev-master" version. For regular modules, use regular versions.-->

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

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

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure the following modules have been installed:

| MODULE | EXPECTED DIRECTORY <!--for public Demo Shops--> |
Expand All @@ -45,6 +55,14 @@ Make sure the following modules have been installed:
### Set up the configuration
<!--Describe system and module configuration changes. If the default configuration is enough for a primary behavior, skip this step.-->

<!--Only define those configs which have to be overridden / defined by the customer. Configs that are working out of the box, should not be listed.-->

<!--Conventions:
* The "prerequisites" column in the installation guide tables can define behavioral requirements (fulfilled by any "specification" column).
* The "specification" column has to describe what is the behavior of the widget so that the customer can understand it.
* The "specification" column has to describe what is the behavior of the controller so that the customer can understand it.
-->

Add the following configuration:

| CONFIGURATION | SPECIFICATION | NAMESPACE |
Expand All @@ -58,6 +76,13 @@ Add the following configuration:
{% info_block warningBox "Verification" %}

<!--Describe how a developer can check they have completed the step correctly.-->
<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

{% endinfo_block %}

Expand All @@ -83,6 +108,14 @@ console transfer:generate
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure the following changes have been applied by checking your database:

| DATABASE ENTITY | TYPE | EVENT |
Expand Down Expand Up @@ -121,6 +154,14 @@ console transfer:generate
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure that following changes have been applied by checking your database:

| DATABASE ENTITY | TYPE | EVENT |
Expand All @@ -140,6 +181,14 @@ console transfer:generate
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Ensure the following transfers have been created:

| TRANSFER | TYPE | EVENT | PATH |
Expand Down Expand Up @@ -168,13 +217,21 @@ console data:import glossary
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

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.-->


Configure tables to be published and synchronized to the Storage on create, edit, and delete changes.
<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
| --------------- | -------------- | ------ | -------------- |
Expand Down Expand Up @@ -206,6 +263,7 @@ Expected data fragment example:

Configure tables to be published to the {table name} table and synchronized to the Storage on create, edit, and delete changes.

<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
| -------- | ------------- | ---------------- | --------- |
Expand Down Expand Up @@ -237,6 +295,8 @@ Expected data fragment example: {target entity}

Install the following plugins:

<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
| -------- | ------------- | --------------- | --------- |
| {plugin} | {Description} | {prerequisite}<!--leave blank if "None"-->| {namespace} |
Expand Down Expand Up @@ -287,6 +347,14 @@ Import data as follows:
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

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

#### Import infrastructural data
Expand All @@ -296,6 +364,8 @@ Import infrastructural data as follows:

1. Install the plugins:

<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
| -------- | ------------- | --------------- | --------- |
| {plugin} | {Description} | {{prerequisite} / } <!-- if none, leave blank -->| {namespace} |
Expand All @@ -318,6 +388,8 @@ 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.-->

<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
| -------- | ------------- | --------------- | --------- |
| {plugin} | {Description} | {{prerequisite} / } <!-- if none, leave blank -->| {namespace} |
Expand All @@ -334,7 +406,7 @@ Ensure that the {entities} have been added to the `{table_name}` table.
* [Configure Export to Redis](#configure-export-to-redis) -->

### Set up behavior
<!--This is a comment, it will not be included -->
<!--The "specification" column has to describe what is the behaviour of the plugin so that the customer can understand it. This should contain the necessary information for the following "prerequisites" column.-->
Enable the following behaviors by registering the plugins:

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
Expand All @@ -348,6 +420,14 @@ Enable the following behaviors by registering the plugins:
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

## Install feature frontend

Follow the steps below to install the {Feature Name} feature frontend.
Expand All @@ -374,6 +454,14 @@ Install the required modules:
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure the following modules have been installed:

| MODULE | EXPECTED DIRECTORY <!--for public Demo Shops--> |
Expand All @@ -399,6 +487,14 @@ console data:import glossary
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure that the configured data has been added to the `spy_glossary_key` and `spy_glossary_translation` tables.

---
Expand All @@ -419,6 +515,14 @@ Register the following route providers on the Storefront:
**Verification**
<!--Describe how a developer can check they have completed the step correctly.-->

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

### 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 All @@ -438,6 +542,14 @@ Set up widgets as follows:

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

<!--Each step needs verification to make sure that the customer did not skip anything unintentionally.
The verification needs to cover the entire "step".
The verification step often needs to use an example domain, use
- "mysprykershop.com"
- "zed.mysprykershop.com"
- "glue.mysprykershop.com"
domains according to your requirements.-->

Make sure the following widgets have been registered by adding the respective code snippets to a Twig template:

| WIDGET | VERIFICATION |
Expand Down
Loading