diff --git a/README.md b/README.md index ed29176..1ae764f 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ This Bundle has been created to serve the function of parsing / processing the e parameter-/options array that exists within a standard symfony and especially eZ - / Ibexa - Platform app. **Similar to the eZPublish Ini settings viewer** of old, it is supposed to take the existing configuration and provide a visual representation that -is easy to read, understand and work with for developers. Therefore, it provides various +is easy to read, understand and work with for developers. Therefore, it provides various functions, options and views to display site access context specific parameters, values and much more. # Provided Functionality -Installing the bundle (refer to `Installation` further down the page), will add a `Config Processing View` tab under the -`Admin` tab of the standard eZ / Ibexa Backoffice. Clicking that tab will bring you to the frontend this bundle provides +Installing the bundle (refer to `Installation` further down the page), will add a `Config Processing View` tab under the +`Admin` tab of the standard eZ / Ibexa Backoffice. Clicking that tab will bring you to the frontend this bundle provides with the following functionality (excerpt): - **Display** of the entire configuration of your Symfony project @@ -38,22 +38,22 @@ Make sure Composer is installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation. -* **Installing the newest (stable) build of the bundle:** +* **Installing the newest (stable) build of the bundle for the highest supported eZ / Ibexa Platform version:** ```shell - $ composer require cjw-network/cjw-config-processor + $ composer require cjw-network/cjw-config-processor ``` * **Installing the bundle for eZ / Ibexa platform version 3.***: ```shell $ composer require cjw-network/cjw-config-processor:3.* ``` - * [**More info and details**](Resources/doc/installation/3.x-Installation.en.md) + * [**Next Steps and Details**](Resources/doc/installation/3.x-Installation.en.md) * **Installing the bundle for eZ / Ibexa platform version 2.***: ```shell $ composer require cjw-network/cjw-config-processor:2.* ``` - * [**More info and details**](Resources/doc/installation/2.x-Installation.en.md) + * [**Next Steps and Details**](Resources/doc/installation/2.x-Installation.en.md) # Authors diff --git a/Resources/doc/installation/2.x-Installation.en.md b/Resources/doc/installation/2.x-Installation.en.md index 3e3e4ea..619c5ef 100644 --- a/Resources/doc/installation/2.x-Installation.en.md +++ b/Resources/doc/installation/2.x-Installation.en.md @@ -44,16 +44,19 @@ Afterwards, you need to add the following content to your `app/config/routing.ya # app/config/routing.yml #... cjw_config_processor_bundle: - resource: "@CJWConfigProcessorBundle/Resources/config/routing.yaml" + resource: "@CJWConfigProcessorBundle/Resources/config/routing.yaml" ``` -## Additional Bundle Config +## Required Bundle Config -You can also customize a few bundle settings and adapt the bundle to your requirements. -To do that, you can create a yaml file in the `app/config` directory of your -installation (the config can also be added to any other existing yaml file in the config directory). -If you did create a new file, name the file however you like, for example `cjw_config_processor.yaml`. -Finally, set the following options: + +**For more info on how to configure and customize the behaviour of the bundle check: +[Configure the ConfigProcessor](../help/bundle_configuration.en.md)** + +You can also customize a few bundle settings and adapt the bundle to your requirements (for more info on that, check the link above). +To do that, you can either write the following configuration into the `app/config/config.yml` +file, or you can create a yaml file in the `app/config` directory of your installation. +If you did not create a file, simply paste the following lines into the `app/config/config.yml`. ```yaml # example settings @@ -62,19 +65,33 @@ cjw_config_processor: allow: false scan_parameters: false parameters: - - "parameter1" - - "parameter2.with.more.parts" - - "parameter3.parts" + - "user.defined.parameters" favourite_parameters: allow: true scan_parameters: true parameters: - - "parameter1.very.specific" - - "parameter2.broader" - - "parameter3" - - "parameter2.others" + - "user.defined.parameters" ``` -**For more info on how to configure and customize the behaviour of the bundle check: -[Configure the ConfigProcessor](../help/bundle_configuration.en.md)** +If you did create a new file, name the file however you like, for example `cjw_config_processor.yaml`. +Finally, set the following line in the `app/config/config.yml` and afterwards paste the lines from above into your created file: + +```yaml +import: + #.. + - { resource: } # If you named it "cjw_config_processor.yaml", then write that name there +``` + +## Assets + +Since it may happen, that composer does not automatically install the assets of this bundle after +installing the bundle itself, to install the assets of the bundle simply write: + +```shell +# For the assets to be copied into the assets folder: +$ php bin/console assets:install + +# To Symlink the assets: +$ php bin/console assets:install --relative --symlink +``` diff --git a/Resources/doc/installation/3.x-Installation.en.md b/Resources/doc/installation/3.x-Installation.en.md index 64165f3..3057900 100644 --- a/Resources/doc/installation/3.x-Installation.en.md +++ b/Resources/doc/installation/3.x-Installation.en.md @@ -60,11 +60,14 @@ the following content: ```yaml cjw_config_processor_bundle: - resource: "@CJWConfigProcessorBundle/Resources/config/routing.yaml" + resource: "@CJWConfigProcessorBundle/Resources/config/routing.yaml" ``` ## Additional Bundle Config +**For more info on how to configure and customize the behaviour of the bundle check: +[Configure the ConfigProcessor](../help/bundle_configuration.en.md)** + You can also customize a few bundle settings and adapt the bundle to your requirements. To do that, you can create a yaml file in the `config/packages` directory of your installation (the config can also be added to any other existing yaml file in the config directory). @@ -78,19 +81,24 @@ cjw_config_processor: allow: false scan_parameters: false parameters: - - "parameter1" - - "parameter2.with.more.parts" - - "parameter3.parts" + - "user.defined.parameters" favourite_parameters: allow: true scan_parameters: true parameters: - - "parameter1.very.specific" - - "parameter2.broader" - - "parameter3" - - "parameter2.others" + - "user.defined.parameters" ``` -**For more info on how to configure and customize the behaviour of the bundle check: -[Configure the ConfigProcessor](../help/bundle_configuration.en.md)** +## Assets + +Since it may happen, that composer does not automatically install the assets of this bundle after +installing the bundle itself, to install the assets of the bundle simply write: + +```shell +# For the assets to be copied into the assets folder: +$ php bin/console assets:install + +# To Symlink the assets: +$ php bin/console assets:install --relative --symlink +```