From b18641b456410fe9278e8719188a95cbae91ab5c Mon Sep 17 00:00:00 2001 From: Filip Sushko Date: Fri, 22 Feb 2019 16:10:33 +0200 Subject: [PATCH 1/3] Updated README file with examples of directories structures --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index edbc35a6..2972cce4 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,35 @@ If you only need to add a new Spryk configuration you will start by adding an In When this is done run the Integration tests with `vendor/bin/codecept run Integration -g {YOUR TEST GROUP}` and see the test failing. You will get a message that the Spryk definition was not found by the given name, so add the definition file for you new Spryk. -You need to add your Spryk definition file into `vendor/spryker-sdk/spryk/config/spryk/spryks` when you added your new Spryk definition file re-run the tests. Now it dependends on the spryk type you choosed for your Spryk definition what comes next. +You need to add your Spryk definition file into `config/spryk/spryks` on project or core layer: -If you selected the template Spryk you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `vendor/spryker-sdk/spryk/config/spryk/templates` when this is done re-run your tests. Now you should see a green test. +``` +project OR package root directory +│ +└─── config +│ └─── ... +│ └─── spryk +│ │ └─── spryks +│ │ │ ... +│ │ │ spryk-name.yml +│ │ │ ... +│ └─── ... +``` + +If you selected the template Spryk you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates` on project or core layer: + +``` +project OR package root directory +│ +└─── config +│ └─── ... +│ └─── spryk +│ │ └─── spryks +│ │ └─── templates +│ │ │ ... +│ │ │ template-name.twig +│ │ │ ... +│ └─── ... +``` + +When this is done re-run your tests. Now you should see a green test. From 487bdb770818a73200289fed289d78be44dad650 Mon Sep 17 00:00:00 2001 From: Filip Sushko Date: Thu, 14 Mar 2019 14:42:17 +0200 Subject: [PATCH 2/3] Updated readme after CR --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2972cce4..cb5c4e30 100644 --- a/README.md +++ b/README.md @@ -107,26 +107,23 @@ You need to add your Spryk definition file into `config/spryk/spryks` on project ``` project OR package root directory │ -└─── config -│ └─── ... -│ └─── spryk -│ │ └─── spryks +└─── config/ +│ └─── spryk/ +│ │ └─── spryks/ │ │ │ ... │ │ │ spryk-name.yml │ │ │ ... │ └─── ... ``` -If you selected the template Spryk you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates` on project or core layer: +If you selected the template Spryk, you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates/` on project or core layer: ``` project OR package root directory │ -└─── config -│ └─── ... -│ └─── spryk -│ │ └─── spryks -│ │ └─── templates +└─── config/ +│ └─── spryk/ +│ │ └─── templates/ │ │ │ ... │ │ │ template-name.twig │ │ │ ... From af47b8b758a7898d6bd1837aa725d65435c69f08 Mon Sep 17 00:00:00 2001 From: Filip Sushko Date: Thu, 14 Mar 2019 15:07:06 +0200 Subject: [PATCH 3/3] Updated readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cb5c4e30..b716c404 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ If you only need to add a new Spryk configuration you will start by adding an In When this is done run the Integration tests with `vendor/bin/codecept run Integration -g {YOUR TEST GROUP}` and see the test failing. You will get a message that the Spryk definition was not found by the given name, so add the definition file for you new Spryk. -You need to add your Spryk definition file into `config/spryk/spryks` on project or core layer: +You need to add your Spryk definition file into `config/spryk/spryks/` on project or core level: ``` project OR package root directory @@ -116,7 +116,7 @@ project OR package root directory │ └─── ... ``` -If you selected the template Spryk, you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates/` on project or core layer: +If you selected the template Spryk, you will most likely see the error that the defined template file could not be found. In this case you need to add your template to `config/spryk/templates/` on project or core level: ``` project OR package root directory