add upgrade 4.4 doc, divide configuration, update installation steps

Author: christopherhero

UPGRADE-4.4.md

@@ -0,0 +1,17 @@
+# UPGRADE FROM `v4.3` TO `v4.4`
+
+This update adds support for Trix (as an optional WYSIWYG editor). If you would like to replace CKeditor with Trix review the plugin installation steps.
+
+Therefore, the configuration has been split and the `fos_ck_editor` configuration is required to be added with this update.
+
+Import required CKeditor config in your `config/packages/_sylius.yaml` file:
+```yaml
+# config/packages/_sylius.yaml
+
+imports:
+    ...
+    
+    - { resource: "@BitBagSyliusCmsPlugin/Resources/config/fos_ck_editor/fos_ck_editor.yml" }
+```
+
+Or copy contents of `vendor/BitBag/cms-plugin/src/Resources/config/fos_ck_editor/fos_ck_editor.yml` to `config/packages/fos_ck_editor.yaml` file.

doc/ckeditor-config.md

@@ -9,7 +9,7 @@ return [
 ];
 ```
 
-Install CKeditor ([FOS CKEditor](https://symfony.com/doc/master/bundles/FOSCKEditorBundle/usage/ckeditor.html))
+2. Install CKeditor ([FOS CKEditor](https://symfony.com/doc/master/bundles/FOSCKEditorBundle/usage/ckeditor.html))
 
 ```bash
 $ bin/console ckeditor:install
@@ -23,7 +23,7 @@ $ bin/console ckeditor:install --tag=4.22.1
 
 For more information regarding the `4.22.1` tag, please visit the #485 issue.
 
-Since FOSCKEditorBundle 2.0, to make Twig render the WYSIWYG editor, you must add some configuration under the `twig.form_themes` config key:
+3. Since FOSCKEditorBundle 2.0, to make Twig render the WYSIWYG editor, you must add some configuration under the `twig.form_themes` config key:
 
 ```yaml
 # Symfony 2/3: app/config/config.yml
@@ -34,3 +34,15 @@ twig:
         - '@FOSCKEditor/Form/ckeditor_widget.html.twig'
         - '@BitBagSyliusCmsPlugin/Form/ckeditor_widget.html.twig'
 ```
+
+4. Import required CKeditor config in your `config/packages/_sylius.yaml` file:
+```yaml
+# config/packages/_sylius.yaml
+
+imports:
+    ...
+    
+    - { resource: "@BitBagSyliusCmsPlugin/Resources/config/fos_ck_editor/fos_ck_editor.yml" }
+```
+
+Continue with the next installation steps

doc/installation.md

@@ -1,13 +1,13 @@
 ## Installation
 
 
-1. *We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.*
+##### 1. *We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.*
 
 ```bash
 $ composer require bitbag/cms-plugin --no-scripts
 ```
 
-2. Add plugin dependencies to your `config/bundles.php` file:
+##### 2. Add plugin dependencies to your `config/bundles.php` file:
 
 ```php
 return [
@@ -16,7 +16,7 @@ return [
 ];
 ```
 
-3. Configure a WYSIWYG editor.
+##### 3. Configure a WYSIWYG editor.
 
 The plugin supports two WYSIWYG editors: [FOS CKEditor](https://symfony.com/doc/master/bundles/FOSCKEditorBundle/usage/ckeditor.html) by default and [Trix](https://trix-editor.org/) as an alternative. 
 
@@ -25,7 +25,7 @@ You can choose which one you want to use by following one of the guides below:
 - [Trix WYSIWYG config](./trix-config.md)*
 - [CKeditor WYSIWYG config](./ckeditor-config.md)*
 
-4. Import required config in your `config/packages/_sylius.yaml` file:
+##### 4. Import required config in your `config/packages/_sylius.yaml` file:
 ```yaml
 # config/packages/_sylius.yaml
 
@@ -35,7 +35,7 @@ imports:
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/config.yml" }
 ```
 
-5. Import routing in your `config/routes.yaml` file:
+##### 5. Import routing in your `config/routes.yaml` file:
 
 ```yaml
 
@@ -73,7 +73,7 @@ you will probably need to change the extension of the imported file in
         - { resource: "@SitemapPlugin/Resources/config/config.yaml" }
 ```
 
-6. Finish the installation by updating the database schema and installing assets:
+##### 6. Finish the installation by updating the database schema and installing assets:
 
 ```bash
 $ bin/console cache:clear
@@ -89,7 +89,7 @@ $ bin/console sylius:theme:assets:install --symlink
 
 **Note.** In some cases, the `--symlink` option [may throw some errors](https://github.com/Sylius/SyliusThemeBundle/issues/91). If you consider running the commands without the `--symlink` option, please keep in mind to run them on every potential plugin update.
 
-7. Add plugin assets to your project
+##### 7. Add plugin assets to your project
 
 We recommend you to use Webpack (Encore), for which we have prepared four different instructions on how to add this plugin's assets to your project:
 
@@ -105,7 +105,7 @@ However, if you are not using Webpack, here are instructions on how to add optim
 
 - [Non webpack solution](./01.5-non-webpack.md)
 
-8. Passing required "backend" values to "frontend"
+##### 8. Passing required "backend" values to "frontend"
 
 In order to make plugin finally work you need to declare "route", in admin _scripts.html.twig you can pass:
 

src/Resources/config/config.yml

@@ -1,6 +1,5 @@
 imports:
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/resources.yml" }
-    - { resource: "@BitBagSyliusCmsPlugin/Resources/config/fos_ck_editor/fos_ck_editor.yml" }
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/grids.yml" }
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/services.xml" }
 

tests/Application/config/packages/bitbag_sylius_cms_plugin.yaml

@@ -1,5 +1,6 @@
 imports:
     - { resource: "@BitBagSyliusCmsPlugin/Resources/config/config.yml" }
+    - { resource: "@BitBagSyliusCmsPlugin/Resources/config/fos_ck_editor/fos_ck_editor.yml" }
 
 parameters:
     fixtures_dir: "%kernel.project_dir%/Resources/fixtures"