From 773075fa3dfdfe3251f81778681b03efce5c6dce Mon Sep 17 00:00:00 2001 From: DominikaK Date: Wed, 5 Jun 2019 13:51:56 +0200 Subject: [PATCH 1/9] Symfony 4 bundle notation --- docs/api/extending_the_rest_api.md | 4 ++-- docs/api/field_type_reference.md | 6 +++--- docs/cookbook/displaying_children_of_a_content_item.md | 2 +- docs/guide/controllers.md | 4 ++-- docs/guide/internationalization.md | 2 +- docs/guide/page_rendering.md | 8 ++++---- .../enterprise_beginner/2_prepare_the_landing_page.md | 4 ++-- .../extending_admin_ui/3_creating_a_content_list.md | 2 +- .../extending_admin_ui/4_filtering_the_content_list.md | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/extending_the_rest_api.md b/docs/api/extending_the_rest_api.md index 6b94f64dc4..28dd10a13a 100644 --- a/docs/api/extending_the_rest_api.md +++ b/docs/api/extending_the_rest_api.md @@ -58,7 +58,7 @@ Next, you need to create the REST route. Define the route's [controller as a ser myRestBundle_hello_world: path: '/my_rest_bundle/hello/{name}' defaults: - _controller: myRestBundle.controller.default:sayHello + _controller: My\Bundle\RestBundle\Rest\Controller\DefaultController::sayHelloAction methods: [GET] ``` @@ -286,7 +286,7 @@ Finally, a new Route should be added to `routing_rest.yml` myRestBundle_hello_world_using_post: path: /my_rest_bundle/hello/ defaults: - _controller: myRestBundle.controller.default:sayHelloUsingPost + _controller: My\Bundle\RestBundle\Rest\Controller\DefaultController::sayHelloUsingPostAction methods: [POST] ``` diff --git a/docs/api/field_type_reference.md b/docs/api/field_type_reference.md index d872703123..75266b5875 100644 --- a/docs/api/field_type_reference.md +++ b/docs/api/field_type_reference.md @@ -1707,7 +1707,7 @@ services: Example usage: ``` html+twig - {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController::renderAction', { 'locationId': locationId, 'blockId': block.id, 'versionNo': versionInfo.versionNo, @@ -1727,9 +1727,9 @@ services: {% for block in blocks %} {# create a new layer with appropriate ID #}
- {# render the block by using the "EzPlatformPageFieldTypeBundle:Block:render" controller #} + {# render the block by using the "EzPlatformPageFieldTypeBundle\Controller\BlockController::renderAction" controller #} {# location.id is the ID of the Location of the current Content item, block.id is the ID of the current block #} - {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController::renderAction', { 'locationId': locationId, 'blockId': block.id, 'versionNo': versionInfo.versionNo, diff --git a/docs/cookbook/displaying_children_of_a_content_item.md b/docs/cookbook/displaying_children_of_a_content_item.md index 2b7d5792db..d9393d2489 100644 --- a/docs/cookbook/displaying_children_of_a_content_item.md +++ b/docs/cookbook/displaying_children_of_a_content_item.md @@ -81,7 +81,7 @@ Configuring for the use of a Custom Controller starts with pointing to it in you ``` yaml folder: - controller: app.controller.folder:showAction + controller: app.controller.folder::showAction template: full/folder.html.twig match: Identifier\ContentType: folder diff --git a/docs/guide/controllers.md b/docs/guide/controllers.md index d79407f5ae..d82be10d3e 100644 --- a/docs/guide/controllers.md +++ b/docs/guide/controllers.md @@ -38,7 +38,7 @@ ezpublish: content_view: full: article: - controller: AcmeTestBundle:Default:articleViewEnhanced + controller: Acme\TestBundle\Controller\DefaultController::articleViewEnhancedAction template: AcmeTestBundle:full:article.html.twig match: Identifier\ContentType: [article] @@ -106,7 +106,7 @@ ezpublish: content_view: full: folder: - controller: AcmeTestBundle:Default:viewFolder + controller: Acme\TestBundle\Controller\DefaultController::viewFolderAction match: Identifier\ContentType: [folder] Identifier\Section: [standard] diff --git a/docs/guide/internationalization.md b/docs/guide/internationalization.md index c965591dd8..7dc1ef57f6 100644 --- a/docs/guide/internationalization.md +++ b/docs/guide/internationalization.md @@ -80,7 +80,7 @@ If you want to render language switch links in a sub-request with a correct `Ro ``` html+twig {# Render the language switch links in a sub-controller #} -{{ render( controller( 'AcmeTestBundle:Default:languages', {'routeRef': ez_route()} ) ) }} +{{ render( controller( 'Acme\TestBundle\Controller\DefaultController::languagesAction', {'routeRef': ez_route()} ) ) }} ``` ``` php diff --git a/docs/guide/page_rendering.md b/docs/guide/page_rendering.md index f3b7c50601..5245b19233 100644 --- a/docs/guide/page_rendering.md +++ b/docs/guide/page_rendering.md @@ -73,8 +73,8 @@ {# create a new layer with appropriate id #} {# the div's class takes the type of the block that is placed in it #}
- {# render the block by using the "EzPlatformPageFieldTypeBundle:Block:render" controller #} - {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {# render the block by using the "EzPlatformPageFieldTypeBundle\Controller\BlockController:renderAction" controller #} + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController:renderAction', { 'contentId': contentInfo.id, 'blockId': block.id, 'versionNo': versionInfo.versionNo, @@ -90,7 +90,7 @@ {% if zones[1].blocks %} {% for block in zones[1].blocks %}
- {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController:renderAction', { 'contentId': contentInfo.id, 'blockId': block.id, 'versionNo': versionInfo.versionNo, @@ -139,4 +139,4 @@ {% import 'app/Resources/views/blocks/gallery/new_default.html.twig'} ``` - Then, place the actual template in the imported file `app/Resources/views/blocks/gallery/new_default.html.twig`. \ No newline at end of file + Then, place the actual template in the imported file `app/Resources/views/blocks/gallery/new_default.html.twig`. diff --git a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md index 2cf41684b5..e5fac43887 100644 --- a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md +++ b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md @@ -94,7 +94,7 @@ Create an `app/Resources/views/layouts/sidebar.html.twig` file: {% for block in zones[0].blocks %}
- {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController::renderAction', { 'locationId': locationId, 'contentId': contentInfo.id, 'blockId': block.id, @@ -111,7 +111,7 @@ Create an `app/Resources/views/layouts/sidebar.html.twig` file: {% for block in zones[1].blocks %}
- {{ render_esi(controller('EzPlatformPageFieldTypeBundle:Block:render', { + {{ render_esi(controller('EzPlatformPageFieldTypeBundle\Controller\BlockController::renderAction', { 'locationId': locationId, 'contentId': contentInfo.id, 'blockId': block.id, diff --git a/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md b/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md index 31ee241c00..e3a52cd02c 100644 --- a/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md +++ b/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md @@ -72,7 +72,7 @@ ezsystems_extending_tutorial.all_content_list.list: path: /all_content_list/{page} defaults: page: 1 - _controller: EzSystemsExtendingTutorialBundle:AllContentList:list + _controller: EzSystems\ExtendingTutorialBundle\Controller\AllContentListController::listAction ``` ## Create a controller diff --git a/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md b/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md index a3526868a5..106e49e97c 100644 --- a/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md +++ b/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md @@ -13,7 +13,7 @@ ezsystems_extending_tutorial.all_content_list.list: defaults: page: 1 contentTypeIdentifier: false - _controller: EzSystemsExtendingTutorialBundle:AllContentList:list + _controller: EzSystems\ExtendingTutorialBundle\Controller\AllContentListControler::listAction ``` ## Modify the controller From 325200b9553a2d9c48adcebc4d37ba8f6cdfd432 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Tue, 21 May 2019 10:36:04 +0200 Subject: [PATCH 2/9] Sf4 project structure --- docs/guide/bundles.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/guide/bundles.md b/docs/guide/bundles.md index 7cfcec01d2..6302980db1 100644 --- a/docs/guide/bundles.md +++ b/docs/guide/bundles.md @@ -2,7 +2,7 @@ ## Dealing with bundles -eZ Platform is based on the Symfony 3 framework and applies a similar way of organizing the app. Like in Symfony, where ["everything is a bundle"](http://symfony.com/doc/current/book/bundles.html), your eZ Platform application is going to be a collection of bundles. +eZ Platform is based on the Symfony framework and applies a similar way of organizing the app. Like in Symfony, where ["everything is a bundle"](http://symfony.com/doc/current/book/bundles.html), your eZ Platform application is going to be a collection of bundles. ### What is a bundle? @@ -26,35 +26,35 @@ You can generate a new bundle using a `generate:bundle` command. See [Symfony do To remove a bundle (either one you created yourself, or an out-of-the-box one that you do not need) see the [How to Remove a Bundle](http://symfony.com/doc/current/bundles/remove.html) instruction in Symfony doc. -## Structuring a bundle +## Structuring your project -### The AppBundle +### PHP code -Most projects can use the provided `AppBundle`, in the `src` folder. It is enabled by default. The project's PHP code (controllers, event listeners, etc.) can be placed there. +The project's PHP code (controllers, event listeners, etc.) should be placed in the `src` folder. Reusable libraries should be packaged so that they can easily be managed using Composer. ### Templates -Project templates should go into `app/Resources/views`. +Project templates should go into the `templates` folder. -They can then be referenced in code without any prefix, for example `app/Resources/views/content/full.html.twig` can be referenced in Twig templates or PHP as `content/full.html.twig`. +They can then be referenced in code without any prefix, for example `templates/full/article.html.twig` can be referenced in Twig templates or PHP as `full/article.html.twig`. ### Assets -Project assets should go into the `web` folder. +Project assets should go into the `assets` folder. -They can be referenced as relative to the root, for example `web/js/script.js` can be referenced as `js/script.js` from templates. +They can be referenced as relative to the root, for example `assets/js/script.js` can be referenced as `js/script.js` from templates. -All project assets are accessible through the `web/assets` path. +All project assets are accessible through the `assets` path. -??? note "Removing `web/assets` manually" +??? note "Removing `assets` manually" - If you ever remove the `web/assets` folder manually, you need to dump translations before performing + If you ever remove the `assets` folder manually, you need to dump translations before performing the `yarn encore ` command: ``` - php bin/console bazinga:js-translation:dump web/assets --merge-domains + php bin/console bazinga:js-translation:dump assets --merge-domains ``` #### Importing assets from a bundle From 4eed07324325a95a2a267970446d8c21b6f003e2 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Wed, 22 May 2019 08:33:58 +0200 Subject: [PATCH 3/9] Config files and AppBundle --- docs/api/extending_the_rest_api.md | 2 +- docs/api/field_type_form_and_template.md | 8 +- docs/api/field_type_storage.md | 4 +- docs/api/general_rest_usage.md | 4 +- docs/api/public_php_api_customization.md | 2 +- docs/api/rest_api_guide.md | 2 +- .../support_maintenance_faq.md | 13 +--- ...ing_a_user_with_multiple_user_providers.md | 12 +-- .../creating_custom_rest_api_response.md | 12 +-- ...mizing_form_builder_email_notifications.md | 20 ++--- .../displaying_children_of_a_content_item.md | 54 ++++---------- ...isplaying_content_with_simple_templates.md | 4 +- ...ess_aware_configuration_for_your_bundle.md | 4 +- .../importing_settings_from_a_bundle.md | 4 +- .../making_cross_origin_http_requests.md | 8 +- .../cookbook/paginating_api_search_results.md | 2 +- docs/cookbook/retrieving_root_location.md | 4 +- docs/cookbook/sending_notifications.md | 9 +-- .../setting_up_multi_language_siteaccesses.md | 2 +- docs/cookbook/using_routereference.md | 10 +-- docs/getting_started/bundles_starter_pack.md | 2 +- docs/getting_started/first_steps.md | 8 +- docs/getting_started/install_ez_platform.md | 2 +- docs/getting_started/troubleshooting.md | 2 +- docs/guide/back_office_translations.md | 2 +- docs/guide/bundles.md | 2 +- docs/guide/clustering_aws_s3.md | 4 +- docs/guide/config_back_office.md | 2 +- docs/guide/config_dynamic.md | 39 +++++----- docs/guide/config_repository.md | 2 +- docs/guide/configuration.md | 2 + docs/guide/content_rendering.md | 22 +++--- docs/guide/controllers.md | 22 +++--- docs/guide/custom_policies.md | 14 ++-- docs/guide/design_engine.md | 30 ++++---- docs/guide/devops.md | 2 +- docs/guide/environments.md | 4 +- docs/guide/extending_ez_platform.md | 32 ++++---- docs/guide/extending_form_builder.md | 10 +-- docs/guide/extending_online_editor.md | 24 +++--- docs/guide/extending_page.md | 15 ++-- docs/guide/file_management.md | 2 +- docs/guide/http_cache.md | 18 ++--- docs/guide/images.md | 3 +- docs/guide/internationalization.md | 10 +-- docs/guide/limitations.md | 2 +- docs/guide/multisite.md | 2 - docs/guide/persistence_cache.md | 15 ++-- docs/guide/richtext_block.md | 74 +++++++++---------- docs/guide/search_engines.md | 2 +- docs/guide/security.md | 10 +-- docs/guide/sessions.md | 10 +-- docs/guide/signalslots.md | 2 +- docs/guide/siteaccess.md | 14 ++-- docs/guide/solr.md | 21 ++---- docs/guide/templates.md | 28 +++---- docs/guide/twig_functions_reference.md | 10 +-- docs/guide/url_management.md | 4 +- docs/guide/user_management.md | 4 +- 59 files changed, 294 insertions(+), 359 deletions(-) diff --git a/docs/api/extending_the_rest_api.md b/docs/api/extending_the_rest_api.md index 28dd10a13a..eb0a698540 100644 --- a/docs/api/extending_the_rest_api.md +++ b/docs/api/extending_the_rest_api.md @@ -40,7 +40,7 @@ class DefaultController extends BaseController As mentioned earlier, your REST routes are required to use the REST URI prefix. To do so, the easiest way is to import your routing file using this prefix. -**app/config/routing.yml** +**config/packages/routing.yaml** ``` yaml myRestBundle_rest_routes: diff --git a/docs/api/field_type_form_and_template.md b/docs/api/field_type_form_and_template.md index a15807b7c4..1dd9762809 100644 --- a/docs/api/field_type_form_and_template.md +++ b/docs/api/field_type_form_and_template.md @@ -103,7 +103,7 @@ The special `defaultValue` key allows you to specify a field for setting the def The FormMapper must be registered as a service: ``` yaml -Acme\ExampleBundle\FieldType\Mapper\CustomFieldTypeMapper: +App\FieldType\Mapper\CustomFieldTypeMapper: tags: - { name: ez.fieldFormMapper.definition, fieldType: custom } - { name: ez.fieldFormMapper.value, fieldType: custom } @@ -172,7 +172,7 @@ ezpublish: : field_templates: - - template: 'AcmeExampleBundle:fields:custom_field_template.html.twig' + template: 'fields/custom_field_template.html.twig' # Priority is optional (default is 0). The higher it is, the higher your template gets in the list. priority: 10 ``` @@ -192,7 +192,7 @@ ezpublish: systems: admin_group: field_templates: - - { template: 'AcmeExampleBundle:adminui/field:custom_field_view.html.twig', priority: 10 } + - { template: 'adminui/field/custom_field_view.html.twig', priority: 10 } ``` ### Field edit template @@ -203,7 +203,7 @@ under the `twig.form_themes` key: ``` yaml twig: form_themes: - - 'AcmeExampleBundle:adminui/field:custom_field_template.html.twig' + - 'adminui/field/custom_field_template.html.twig' ``` We encourage using custom form types for encapsulation as this makes templating easier by providing Twig block name. diff --git a/docs/api/field_type_storage.md b/docs/api/field_type_storage.md index 9a35ca2a9a..33b7db9586 100644 --- a/docs/api/field_type_storage.md +++ b/docs/api/field_type_storage.md @@ -125,7 +125,7 @@ services: autoconfigure: true public: false - Acme\ExampleBundle\FieldType\MyField\Storage\MyFieldStorage: ~ + App\FieldType\MyField\Storage\MyFieldStorage: ~ tags: - {name: ezpublish.fieldType.externalStorageHandler, alias: myfield} ``` @@ -145,7 +145,7 @@ services: autoconfigure: true public: false - Acme\ExampleBundle\FieldType\MyField\Storage\Gateway\DoctrineStorage: ~ + App\FieldType\MyField\Storage\Gateway\DoctrineStorage: ~ ``` Note that `ezpublish.api.storage_engine.legacy.connection` is of type `Doctrine\DBAL\Connection`. If your gateway still uses an implementation of `eZ\Publish\Core\Persistence\Database\DatabaseHandler` (`eZ\Publish\Core\Persistence\Doctrine\ConnectionHandler`), instead of the `ezpublish.api.storage_engine.legacy.connection`, you can pass the `ezpublish.api.storage_engine.legacy.dbhandler` service. diff --git a/docs/api/general_rest_usage.md b/docs/api/general_rest_usage.md index 8adbff9114..2f863ea556 100644 --- a/docs/api/general_rest_usage.md +++ b/docs/api/general_rest_usage.md @@ -261,14 +261,12 @@ More information can be found in [Session-based authentication chapter of the RE ### HTTP Basic authentication -To enable HTTP basic authentication, you need to edit `app/config/security.yml`, and add/uncomment the following block. Note that this is enabled by default. +To enable HTTP basic authentication, you need to edit `config/packages/security.yaml`, and add/uncomment the following block. Note that this is enabled by default. !!! caution Until [EZP-22192](https://jira.ez.no/browse/EZP-22192) is implemented, enabling basic authentication in REST will prevent PlatformUI from working. -**ezplatform.yml** - ``` yaml ezpublish_rest: pattern: ^/api/ezp/v2 diff --git a/docs/api/public_php_api_customization.md b/docs/api/public_php_api_customization.md index 74e09c4cb3..8e07bf0acc 100644 --- a/docs/api/public_php_api_customization.md +++ b/docs/api/public_php_api_customization.md @@ -99,7 +99,7 @@ You are going to generate a "EzSystems\Bundle\CookbookBundle\EzSystemsCookbookBu Do you confirm generation [yes]? yes ``` -The wizard will generate the bundle, check autoloading, and ask about the activation of your bundle. Hit Enter in the answer to both questions to have your bundle automatically added to your kernel (`app/AppKernel.php`) and routes from your bundle added to the existing routes (`app/config/routing.yml`). +The wizard will generate the bundle, check autoloading, and ask about the activation of your bundle. Hit Enter in the answer to both questions to have your bundle automatically added to your kernel (`app/AppKernel.php`) and routes from your bundle added to the existing routes (`config/packages/routing.yaml`). **Activation and generation** diff --git a/docs/api/rest_api_guide.md b/docs/api/rest_api_guide.md index 918028ff7f..ebacb7b3f1 100644 --- a/docs/api/rest_api_guide.md +++ b/docs/api/rest_api_guide.md @@ -70,7 +70,7 @@ No special preparations are necessary to use the REST API. As long as your eZ Pl As explained in more detail in the [authentication page](general_rest_usage.md#rest-api-authentication), two authentication methods are currently supported: session and basic. By default, session authentication is the active mode, it uses a session cookie. The alternative, basic auth authentication requires a login / password to be sent using basic HTTP authentication. -To enable basic auth based authentication, you need to edit `app/config/security.yml` and uncomment the configuration block about REST +To enable basic auth based authentication, you need to edit `config/packages/security.yaml` and uncomment the configuration block about REST **security.yml** diff --git a/docs/community_resources/support_maintenance_faq.md b/docs/community_resources/support_maintenance_faq.md index 3e387b49f0..d1f660cc41 100644 --- a/docs/community_resources/support_maintenance_faq.md +++ b/docs/community_resources/support_maintenance_faq.md @@ -32,7 +32,7 @@ The language of the Back Office is based on the browser language. In order to change it you should install the proper package for your language (see [language packages list](https://github.com/ezplatform-i18n)). Once you have language packages installed, you can switch the language of the Back Office in the User Settings menu. -If you do not have a language defined in the browser, it will be selected based on the `parameters.locale_fallback` parameter located in `default_parameters.yml`. +If you do not have a language defined in the browser, it will be selected based on the `parameters.locale_fallback` parameter located in `config/packages/ezplatform.yaml`. To read more about language managing in eZ Platform, see the following doc pages: @@ -98,21 +98,14 @@ rm -rf var/cache/* In order to avoid merge conflicts on important configuration settings during upgrades, moving as much as possible of your configuration to your own files can be a good idea. -There are two basic approaches to achieving that goal: - -1. All project-specific parameters should be kept in separate files, -e.g. configuration for Landing Page Blocks could be placed in `landing_page_blocks.yml` which should be imported in `app/config/config.yml`: +All project-specific parameters should be kept in separate files, +e.g. configuration for Landing Page Blocks could be placed in `landing_page_blocks.yaml` which should be imported in `config/ezplatform.yaml`: ```yaml imports: - { resource: landing_page_blocks.yml } ``` -2. The same configuration could be moved to your bundle e.g. `AppBundle/Resources/config/landing_page_blocks.yml`. - -For more information, see [Configuration documentation](../guide/configuration.md) -and [Symfony best practices](https://symfony.com/doc/3.4/best_practices/configuration.html). - #### How can I implement authentication in an eZ Platform-based project? The best approach is to use Symfony authentication. diff --git a/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md b/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md index 86aa7dc4d7..e47c350f15 100644 --- a/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md +++ b/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md @@ -29,7 +29,7 @@ You can override `getUser()` to return whatever User class you want, as long a Here is a very simple example using the in-memory user provider. ``` yaml -# app/config/security.yml +# config/security.yaml security: providers: # Chaining in_memory and ezpublish user providers @@ -50,15 +50,15 @@ security: ## Implementing the listener -In `services.yml` in your AcmeExampleBundle: +In `services.yaml`: ``` yaml parameters: - acme_example.interactive_event_listener.class: Acme\ExampleBundle\EventListener\InteractiveLoginListener + app.interactive_event_listener.class: App\EventListener\InteractiveLoginListener services: - acme_example.interactive_event_listener: - class: '%acme_example.interactive_event_listener.class%' + app.interactive_event_listener: + class: '%app.interactive_event_listener.class%' arguments: ['@ezpublish.api.service.user'] tags: - { name: kernel.event_subscriber }  @@ -68,7 +68,7 @@ Do not mix `MVCEvents::INTERACTIVE_LOGIN` event (specific to eZ Platform) and `S ``` php {{ ez_content_name(content) }} @@ -87,11 +87,11 @@ folder: Identifier\ContentType: folder ``` -You can see here the standard view config consisting of the `template` and `match` keys. Under the `controller` key you need to provide here the path to the Controller and the action. They are defined in `AppBundle/Controller/FolderController.php`: +You can see here the standard view config consisting of the `template` and `match` keys. Under the `controller` key you need to provide here the path to the Controller and the action. They are defined in `src/Controller/FolderController.php`: ``` php load('services.yml'); - } -} -``` - -Finally, let's use the Controller in a template in `app/Resources/views/full/folder.html.twig`: +Finally, let's use the Controller in a template in `templates/full/folder.html.twig`: ``` html+twig

{{ ez_content_name(content) }}

diff --git a/docs/cookbook/displaying_content_with_simple_templates.md b/docs/cookbook/displaying_content_with_simple_templates.md index 954b85392e..3dc9b42217 100644 --- a/docs/cookbook/displaying_content_with_simple_templates.md +++ b/docs/cookbook/displaying_content_with_simple_templates.md @@ -16,11 +16,11 @@ Let's create a very simple template, called `article.html.twig`, that you will u
``` -Place this file in the `app/Resources/views` folder. +Place this file in the `templates` folder. Now you need a config that will decide when this template is used. -You can place the config in the `app/config` folder in either of two places: a separate file or the preexisting `ezplatform.yml`. In this case you'll use the latter. +You can place the config in the `config` folder in either of two places: a separate file or the preexisting `ezplatform.yaml`. In this case you'll use the latter. In `ezplatform.yml` under the `ezpublish` and `system` keys add the following config (pay attention to indentation. `default` should be indented relative to `system`): diff --git a/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md b/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md index 3b0567c3f1..8d1218e916 100644 --- a/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md +++ b/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md @@ -17,7 +17,7 @@ The goal of this feature is to make it easy to implement a SiteAccess-aware sem ## Semantic configuration parsing -An abstract `Configuration` class has been added, simplifying the way to add a SiteAccess settings tree like the following in `ezplatform.yml` or `config.yml`: +An abstract `Configuration` class has been added, simplifying the way to add a SiteAccess settings tree like the following in `ezplatform.yml`: ``` yaml acme_example: @@ -173,7 +173,7 @@ parameters: language: php ``` -And then this semantic config in `ezplatform.yml or config.yml`: +And then this semantic config in `ezplatform.yml`: ``` yaml acme_example: diff --git a/docs/cookbook/importing_settings_from_a_bundle.md b/docs/cookbook/importing_settings_from_a_bundle.md index f6059affc5..614bc050c6 100644 --- a/docs/cookbook/importing_settings_from_a_bundle.md +++ b/docs/cookbook/importing_settings_from_a_bundle.md @@ -6,7 +6,7 @@ When developing your website it is best practice to use one or several custom bundles. However, dealing with core bundle semantic configuration can be a bit tedious -if you maintain it in the main `app/config/ezplatform.yml` configuration file. +if you maintain it in the main `ezplatform.yaml` configuration file. This page shows how to import configuration from a bundle in two ways: the manual way and the implicit way. @@ -24,7 +24,7 @@ ezpublish: # ... ``` -The `templates_rules.yml` should then be placed in `Resources/config` in AcmeExampleBundle. +The `templates_rules.yaml` should then be placed in `Resources/config` in AcmeExampleBundle. The configuration tree from this file will be merged with the main one. ``` yaml diff --git a/docs/cookbook/making_cross_origin_http_requests.md b/docs/cookbook/making_cross_origin_http_requests.md index 7108e0e615..aaede60d6c 100644 --- a/docs/cookbook/making_cross_origin_http_requests.md +++ b/docs/cookbook/making_cross_origin_http_requests.md @@ -27,8 +27,8 @@ that gets approved/blocked by the server. By default, all cross-origin requests #### Granting an origin default access -To allow a specific host to execute cross-origin requests, you need to add this host to the `nelmio_cors.default.allow_origin` configuration array in `config.yml`. -As an example, in order to allow requests from `http://example.com` you would add those lines to `app/config/config.yml`: +To allow a specific host to execute cross-origin requests, you need to add this host to the `nelmio_cors.default.allow_origin` configuration array in `config/packages/nelmio_cors.yaml`. +As an example, in order to allow requests from `http://example.com` you would add those lines to `nelmio_cors.yaml`: ``` yaml nelmio_cors: @@ -38,8 +38,8 @@ nelmio_cors: #### Changing configuration of NelmioCorsBundle for eZ Platform REST -The default configuration of NelmioCorsBundle for eZ Platform REST paths is set in [nelmio_cors.yml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yml) file. -To adapt these settings to your own needs you have to overwrite them in `app/config/config.yml` file under the same configuration path, for instance: +The default configuration of NelmioCorsBundle for eZ Platform REST paths is set in [nelmio_cors.yaml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yaml) file. +To adapt these settings to your own needs you have to overwrite them in `nelmio_cors.yaml` file under the same configuration path, for instance: ```yaml nelmio_cors: diff --git a/docs/cookbook/paginating_api_search_results.md b/docs/cookbook/paginating_api_search_results.md index 6bde9ecf74..05839b09c4 100644 --- a/docs/cookbook/paginating_api_search_results.md +++ b/docs/cookbook/paginating_api_search_results.md @@ -9,7 +9,7 @@ The following example shows how to use pagination on a list of all Articles in t ``` php twig->render('AppBundle::notification.html.twig', ['notification' => $notification]); + return $this->twig->render('notification.html.twig', ['notification' => $notification]); } public function generateUrl(Notification $notification): ?string @@ -142,8 +142,7 @@ return $this->router->generate('ez_content_draft_edit', [ ]); ``` -You can add the template that is defined above in the `render()` method to one of your custom bundles. -In this example use the `AppBundle`: +You can add the template that is defined above in the `render()` method to one of your custom bundles: ``` {% extends '@ezdesign/account/notifications/list_item.html.twig' %} @@ -185,7 +184,7 @@ services: autowire: true autoconfigure: false public: false - AppBundle\Notification\MyRenderer: + App\Notification\MyRenderer: tags: - { name: ezpublish.notification.renderer, alias: MyNotification:TypeName } ``` diff --git a/docs/cookbook/setting_up_multi_language_siteaccesses.md b/docs/cookbook/setting_up_multi_language_siteaccesses.md index f91cfeaf52..6b91521981 100644 --- a/docs/cookbook/setting_up_multi_language_siteaccesses.md +++ b/docs/cookbook/setting_up_multi_language_siteaccesses.md @@ -76,7 +76,7 @@ siteaccess: !!! note For dynamic URLs you can replace `www.mysite.com` with `%site_domain%` - and then enter `site_domain` as a new entry in `parameters.yml` at the same level as the database settings. + and then enter `site_domain` as a new entry in `services.yml` at the same level as the database settings. Further down in `ezplatform.yml` is the `system` section which comes with the default group named `site_group` (the same group that you modified earlier). Add the new `translation_siteaccesses` here. After the `site_group` you register the SiteAccess languages: diff --git a/docs/cookbook/using_routereference.md b/docs/cookbook/using_routereference.md index 944a73551a..869ab79f7e 100644 --- a/docs/cookbook/using_routereference.md +++ b/docs/cookbook/using_routereference.md @@ -82,7 +82,7 @@ All listeners receive an `eZ\Publish\Core\MVC\Symfony\Event\RouteReferenceGener which contains the current request object and the route reference. ``` php -namespace Acme\AcmeExampleBundle\EventListener; +namespace App\EventListener; use eZ\Publish\Core\MVC\Symfony\Event\RouteReferenceGenerationEvent; use eZ\Publish\Core\MVC\Symfony\MVCEvents; @@ -115,15 +115,15 @@ class MyRouteReferenceListener implements EventSubscriberInterface } ``` -Service declaration (in `AcmeExampleBundle/Resources/config/services.yml`): +Service declaration (in `config/services.yaml`): ``` yaml parameters: - acme.my_route_reference_listener.class: Acme\AcmeExampleBundle\EventListener\MyRouteReferenceListener + app.my_route_reference_listener.class: App\EventListener\MyRouteReferenceListener services: - acme.my_route_reference_listener: - class: '%acme.my_route_reference_listener.class%' + app.my_route_reference_listener: + class: '%app.my_route_reference_listener.class%' tags: - { name: kernel.event_subscriber } ``` diff --git a/docs/getting_started/bundles_starter_pack.md b/docs/getting_started/bundles_starter_pack.md index e621112c0f..e625d30f52 100644 --- a/docs/getting_started/bundles_starter_pack.md +++ b/docs/getting_started/bundles_starter_pack.md @@ -44,7 +44,7 @@ This bundles are not necessarily something you would install but they are useful |------|-----------| |[CookbookBundle](https://github.com/ezsystems/CookbookBundle)|working examples for using eZ Platform Public API| |[ezplatform-com](https://github.com/ezsystems/ezplatform-com)|the eZ Systems Developer Hub for the Open Source PHP CMS eZ Platform (example site)| -|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes to composer.json, AppKernel.php and config necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| +|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| |[ezplatform-demo](https://github.com/ezsystems/ezplatform-demo)|fork of "ezplatform" meta repository, contains code and dependencies for demo distribution of eZ Platform. Not recommended for a clean installation for new projects, but great for observation and learning(example site)| |[TweetFieldTypeBundle](https://github.com/ezsystems/TweetFieldTypeBundle)|bundle that is created in the [Field Type Tutorial](../tutorials/field_type/creating_a_tweet_field_type.md) (example field type)| |[ezplatform-drawio-fieldtype](https://github.com/ezsystems/ezplatform-drawio-fieldtype)| provides support for diagrams editing in eZ Platform via draw.io (example field type)| diff --git a/docs/getting_started/first_steps.md b/docs/getting_started/first_steps.md index 693571f91d..09efd93c4d 100644 --- a/docs/getting_started/first_steps.md +++ b/docs/getting_started/first_steps.md @@ -36,7 +36,7 @@ To display Content in the front page you need to define content views and templa Content views decide which templates and controllers are used to display Content. -1\. In `app/config/ezplatform.yml`, under `ezpublish.system`, uncomment the `site_group` key +1\. In `config/packages/ezplatform.yaml`, under `ezpublish.system`, uncomment the `site_group` key and add the following block (pay attention to indentation: `content_view` should be one level below `site_group`): ``` yaml @@ -82,7 +82,7 @@ You can use SiteAccesses to serve different versions of the website. SiteAccesses are used depending on matching rules. They are set up in YAML configuration under the `ezpublish.siteaccess.list` key. -1\. In `app/config/ezplatform.yml` add a new SiteAccess called `de` for the German version of the website: +1\. In `config/packages/ezplatform.yaml` add a new SiteAccess called `de` for the German version of the website: ``` yaml ezpublish: @@ -157,7 +157,7 @@ Each theme is stored in a separate folder and assigned to a SiteAccess. To create a new theme: -1\. Add the following configuration at the bottom of `app/config/ezplatform.yml` (at the same level as `ezpublish`): +1\. Add the following configuration at the bottom of `config/packages/ezplatform.yaml` (at the same level as `ezpublish`): ``` yaml ezdesign: @@ -175,7 +175,7 @@ ezdesign: This means that the app will look for the `blog_post.html.twig` file in a folder relevant for the SiteAccess: `de_design` for the `de` SiteAccess, or `site_design` for other SiteAccesses in `site_group`. -5\. Create a `themes` folder under `app/Resources/views`, and two folders under it: `de_design` and `site_design`. +5\. Create a `themes` folder under `templates`, and two folders under it: `de_design` and `site_design`. 6\. Move the existing `full\blog_post.html.twig` file under `site_design`. diff --git a/docs/getting_started/install_ez_platform.md b/docs/getting_started/install_ez_platform.md index 6c591d9541..db2d4bee1c 100644 --- a/docs/getting_started/install_ez_platform.md +++ b/docs/getting_started/install_ez_platform.md @@ -120,7 +120,7 @@ After a moment the installer will ask you to provide a few parameters: !!! tip - If you want to change any of these parameters later, you can do it in `app/config/parameters.yml`. + If you want to change any of these parameters later, you can do it in the `.env` file. !!! tip "Using PostgreSQL" diff --git a/docs/getting_started/troubleshooting.md b/docs/getting_started/troubleshooting.md index c2f60be74b..ba5e00a80e 100644 --- a/docs/getting_started/troubleshooting.md +++ b/docs/getting_started/troubleshooting.md @@ -5,7 +5,7 @@ This page lists potential problems that you may encounter while installing, conf ## Initial installation options If you accepted default options during `composer install`, but need to change some of them later, -you can do it in `app/config/parameters.yml`. +you can do it in `.env`. ## Enable swap on systems with limited RAM diff --git a/docs/guide/back_office_translations.md b/docs/guide/back_office_translations.md index d86e479885..4852ccd0c5 100644 --- a/docs/guide/back_office_translations.md +++ b/docs/guide/back_office_translations.md @@ -39,7 +39,7 @@ in the User Settings menu. Otherwise, the language will be selected based on the browser language. If you do not have a language defined in the browser, the language will be selected -based on `parameters.locale_fallback` in `default_parameters.yml`. +based on `parameters.locale_fallback` in `config/packages/ezplatform.yaml`. ## Custom string translations diff --git a/docs/guide/bundles.md b/docs/guide/bundles.md index 6302980db1..6ac95317bd 100644 --- a/docs/guide/bundles.md +++ b/docs/guide/bundles.md @@ -264,7 +264,7 @@ The following tables give an overview of the main eZ Platform bundles. |------|-----------| |[CookbookBundle](https://github.com/ezsystems/CookbookBundle)|working examples for using eZ Platform Public API| |[ezplatform-com](https://github.com/ezsystems/ezplatform-com)|the eZ Systems Developer Hub for the Open Source PHP CMS eZ Platform (example site)| -|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes to composer.json, AppKernel.php and config necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| +|[ezplatform-ee-demo](https://github.com/ezsystems/ezplatform-ee-demo)|fork of the "ezplatform-ee" meta repository, contains changes necessary to enable eZ Platform Enterprise Edition Demo. Not recommended for a clean install for new projects, but great for observation and learning (example site)| |[ezplatform-demo](https://github.com/ezsystems/ezplatform-demo)|fork of "ezplatform" meta repository, contains code and dependencies for demo distribution of eZ Platform. Not recommended for a clean installation for new projects, but great for observation and learning(example site)| |[TweetFieldTypeBundle](https://github.com/ezsystems/TweetFieldTypeBundle)|bundle that is created in the Field Type Tutorial (example field type)| |[ezplatform-drawio-fieldtype](https://github.com/ezsystems/ezplatform-drawio-fieldtype)|provides support for diagrams editing in eZ Platform via draw.io (example field type)| diff --git a/docs/guide/clustering_aws_s3.md b/docs/guide/clustering_aws_s3.md index 705af01c2f..eba7ac38f3 100644 --- a/docs/guide/clustering_aws_s3.md +++ b/docs/guide/clustering_aws_s3.md @@ -27,7 +27,7 @@ The secret key cannot be retrieved again after the key has been created, so don' ## Set up eZ Platform for AWS S3 In your eZ Platform root directory, run `php composer.phar require league/flysystem-aws-s3-v3`. -In your eZ Platform configuration, e.g. `app/config/config.yml`, set up the AWS S3 client: +In your eZ Platform configuration, e.g. `config/packages/ezplatform.yml`, set up the AWS S3 client: ``` yaml services: @@ -72,7 +72,7 @@ ez_io: For example, you could configure one called `gcloud_storage` for a third-party (community-supported) [Google Cloud Storage adapter](https://github.com/thephpleague/flysystem#community-supported). -In your eZ Platform system settings, e.g. `app/config/ezplatform.yml`, enable the binary data handler: +In your eZ Platform system settings, e.g. `config/packages/ezplatform.yaml`, enable the binary data handler: ``` yaml ezpublish: diff --git a/docs/guide/config_back_office.md b/docs/guide/config_back_office.md index b78b18b1ee..42e6387ca2 100644 --- a/docs/guide/config_back_office.md +++ b/docs/guide/config_back_office.md @@ -4,7 +4,7 @@ Copying large subtrees can cause performance issues, so you can limit the number of Content items that can be copied at once using `ezpublish.system..subtree_operations.copy_subtree.limit` -in `parameters.yml`. +in `config/packages/ezplatform-admin-ui.yaml`. The default value is `100`. You can set it to `-1` for no limit, or to `0` to completely disable copying subtrees. diff --git a/docs/guide/config_dynamic.md b/docs/guide/config_dynamic.md index 3bf69084d1..aef19b2779 100644 --- a/docs/guide/config_dynamic.md +++ b/docs/guide/config_dynamic.md @@ -63,7 +63,7 @@ To do this, inject the `ezpublish.config.resolver` service: ``` yaml parameters: - my_service.class: Acme\ExampleBundle\Service + my_service.class: App\Service   services: my_service: @@ -72,7 +72,7 @@ services: ``` ``` php -namespace Acme\ExampleBundle; +namespace App; use eZ\Publish\Core\MVC\ConfigResolverInterface;   @@ -133,17 +133,17 @@ Defining a simple service needing a `languages` parameter (that is, prioritized ``` yaml parameters: - acme_example.my_service.class: Acme\ExampleBundle\MyServiceClass + app.my_service.class: App\MyServiceClass services: - acme_example.my_service: - class: '%acme_example.my_service.class%' + app.my_service: + class: '%app.my_service.class%' calls: - [setLanguages, ['$languages$']] ``` ``` php -namespace Acme\ExampleBundle; +namespace App; class MyServiceClass { @@ -169,16 +169,16 @@ class MyServiceClass ``` yaml parameters: - acme_example.my_service.class: Acme\ExampleBundle\MyServiceClass + app.my_service.class: App\MyServiceClass services: - acme_example.my_service: - class: '%acme_example.my_service.class%' + app.my_service: + class: '%app.my_service.class%' arguments: ['$languages$'] ``` ``` php -namespace Acme\ExampleBundle; +namespace App; class MyServiceClass { @@ -206,24 +206,23 @@ class MyServiceClass ``` yaml parameters: - acme_example.my_service.class: Acme\ExampleBundle\MyServiceClass - # "acme" is our parameter namespace. + app.my_service.class: App\MyServiceClass # Null is the default value. - acme.default.some_parameter: ~ - acme.site_group.some_parameter: value - acme.admin_group.some_parameter: another value + app.default.some_parameter: ~ + app.site_group.some_parameter: value + app.admin_group.some_parameter: another value   services: - acme_example.my_service: - class: '%acme_example.my_service.class%' + app.my_service: + class: '%app.my_service.class%' # The following argument will automatically resolve to the right value, depending on the current SiteAccess. - # We specify "acme" as the namespace we want to use for parameter resolving. + # We specify "app" as the namespace we want to use for parameter resolving. calls: - - [setSomeParameter, ['$some_parameter;acme$']] + - [setSomeParameter, ['$some_parameter;app$']] ``` ``` php -namespace Acme\ExampleBundle; +namespace App; class MyServiceClass { private $myParameter; diff --git a/docs/guide/config_repository.md b/docs/guide/config_repository.md index 9eb57d27d2..f732768366 100644 --- a/docs/guide/config_repository.md +++ b/docs/guide/config_repository.md @@ -91,7 +91,7 @@ repositories: These identifiers can be given human-readable values and can be translated. Those values are used when editing Content Types. The translation domain is `ezplatform_fields_groups`. -This example in `app/Resources/translations/ezplatform_fields_groups.en.yml` defines English names for Field groups: +This example in `translations/ezplatform_fields_groups.en.yml` defines English names for Field groups: ``` yaml content: Content diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 1e5f68d4c8..622048ae48 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -10,6 +10,8 @@ However, you can also use XML or PHP formats for configuration. ### Configuration files +REVIEW + Main configuration files are located in the `app/config` folder. - `parameters.yml` contains infrastructure-related configuration. It is created based on the default settings defined in `parameters.yml.dist`. diff --git a/docs/guide/content_rendering.md b/docs/guide/content_rendering.md index 37ad98a357..7aeedd2541 100644 --- a/docs/guide/content_rendering.md +++ b/docs/guide/content_rendering.md @@ -21,7 +21,6 @@ The **ViewProvider** allows you to configure template selection when using the ` The ViewProvider takes its configuration from your SiteAccess in the `content_view` section. This configuration is [necessary for views to be defined](templates.md#templating-basics) and is a hash built in the following way: ``` yaml -#app/config/ezplatform.yml ezpublish: system: # Defines the scope: a valid SiteAccess, SiteAccess group or even "global" @@ -32,9 +31,8 @@ ezpublish: full:  # A simple unique key for your matching ruleset folderRuleset: - # The template identifier to load, following the Symfony bundle notation for templates - # See http://symfony.com/doc/current/book/controller.html#rendering-templates - template: eZDemoBundle:full:small_folder.html.twig + # The template identifier to load + template: full/small_folder.html.twig # Hash of matchers to use, with their corresponding values to match against match: # The key defines the matcher rule (class name or service identifier) @@ -142,7 +140,7 @@ Like any template, a content view template can use [template inheritance](http:/ If you use different templates for embedded content views, this should not be a problem. If you'd rather use the same template, you can use an extra `no_layout` view parameter for the sub-request, and conditionally extend an empty pagelayout: ``` html+twig -{% extends no_layout ? view_base_layout : "AcmeDemoBundle::pagelayout.html.twig" %} +{% extends no_layout ? view_base_layout : "pagelayout.html.twig" %} {% block content %} ... @@ -168,7 +166,7 @@ Templates for the most common view types (content/full, line, embed, or block) c ###### Example -Add this configuration to `app/config/config.yml` to use `app/Resources/content/view/full.html.twig` as the default template when viewing Content with the `full` view type: +Add this configuration to `config/packages/ezplatform_admin_ui.yaml` to use `templates/content/view/full.html.twig` as the default template when viewing Content with the `full` view type: ``` yaml parameters: @@ -199,8 +197,8 @@ By default, the [Configured ViewProvider](#configuring-views-the-viewprovider) i ``` yaml services: - acme.my_view_provider: - class: Acme\DemoBundle\Content\MyViewProvider + appe.my_view_provider: + class: App\Content\MyViewProvider tags: - {name: ezpublish.view_provider, type: eZ\Publish\Core\MVC\Symfony\View\ContentView, priority: 30} ``` @@ -214,7 +212,7 @@ services: ``` php // Custom ViewProvider id === self::HOMEPAGE_ID) { // Special template for home page, passing "foo" variable to the template - return new ContentView("AcmeDemoBundle:$viewType:home.html.twig", ['foo' => 'bar']); + return new ContentView("$viewType/home.html.twig", ['foo' => 'bar']); } // And let's also check ContentType Id if ($location->contentInfo->contentTypeId === self::FOLDER_CONTENT_TYPE_ID) { - // For view full, it will load AcmeDemoBundle:full:small_folder.html.twig - return new ContentView("AcmeDemoBundle:$viewType:small_folder.html.twig"); + // For view full, it will load full/small_folder.html.twig + return new ContentView("$viewType/small_folder.html.twig"); } return null; diff --git a/docs/guide/controllers.md b/docs/guide/controllers.md index d82be10d3e..2e36c0a6a0 100644 --- a/docs/guide/controllers.md +++ b/docs/guide/controllers.md @@ -38,8 +38,8 @@ ezpublish: content_view: full: article: - controller: Acme\TestBundle\Controller\DefaultController::articleViewEnhancedAction - template: AcmeTestBundle:full:article.html.twig + controller: App\Controller\DefaultController::articleViewEnhancedAction + template: full/article.html.twig match: Identifier\ContentType: [article] ``` @@ -47,10 +47,9 @@ ezpublish: With this configuration, the following controller will forward the request to the built-in `ViewController` with some additional parameters: ``` php -// Controller -{% extends no_layout ? view_base_layout : "eZDemoBundle::pagelayout.html.twig" %} +{% extends no_layout ? view_base_layout : "pagelayout.html.twig" %} {% block content %}

{{ ez_render_field( content, 'title' ) }}

@@ -99,26 +98,24 @@ One way to add custom logic to all responses is to use your own listener. Please If you want to apply only your custom controller **in a given match situation** and not use the `ViewController` at all, in the configuration you need to indicate the controller, but no template, for example: ``` yaml -#ezplatform.yml ezpublish: system: default: content_view: full: folder: - controller: Acme\TestBundle\Controller\DefaultController::viewFolderAction + controller: App\Controller\DefaultController::viewFolderAction match: Identifier\ContentType: [folder] Identifier\Section: [standard] ``` -In this example, as the `ViewController` is not applied, the custom controller takes care of the whole process of displaying content, including pointing to the template to be used (in this case, `AcmeTestBundle::custom_controller_folder.html.twig`): +In this example, as the `ViewController` is not applied, the custom controller takes care of the whole process of displaying content, including pointing to the template to be used (in this case, `full/custom_controller_folder.html.twig`): ``` php -// Controller getContent(); $response = $this->render( - 'AcmeTestBundle::custom_controller_folder.html.twig', + 'full/custom_controller_folder.html.twig', [ 'location' => $location, 'content' => $content, @@ -151,8 +148,7 @@ class DefaultController extends Controller Here again custom parameters can be used in the template, e.g.: ``` html+twig - -{% extends "eZDemoBundle::pagelayout.html.twig" %} +{% extends "pagelayout.html.twig" %} {% block content %}

{{ ez_render_field( content, 'name' ) }}

diff --git a/docs/guide/custom_policies.md b/docs/guide/custom_policies.md index da53999b46..2884616d2c 100644 --- a/docs/guide/custom_policies.md +++ b/docs/guide/custom_policies.md @@ -62,7 +62,7 @@ It defines an abstract `getFiles()` method. Extend `YamlPolicyProvider` and implement `getFiles()` to return absolute paths to your YAML files. ``` php -namespace Acme\ExampleBundle\AcmeExampleBundle\Security; +namespace App\Security; use eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Security\PolicyProvider\YamlPolicyProvider; @@ -77,7 +77,7 @@ class MyPolicyProvider extends YamlPolicyProvider } ``` -In `AcmeExampleBundle/Resources/config/policies.yml`: +In `config/packages/policies.yaml`: ``` yaml custom_module: @@ -125,8 +125,8 @@ To provide support for editing custom policies in the Back Office you need to im Next, register the service in DIC (Dependency Injection Container) with the `ez.limitation.formMapper` tag and set the `limitationType` attribute to the Limitation type's identifier: ```yml -acme.security.limitation.custom_limitation.mapper: - class: 'AppBundle\Security\Limitation\Mapper\CustomLimitationFormMapper' +app.security.limitation.custom_limitation.mapper: + class: 'App\Security\Limitation\Mapper\CustomLimitationFormMapper' arguments: # ... tags: @@ -138,8 +138,8 @@ If you want to provide human-readable names of the custom Limitation values, you Then register the service in DIC with the `ez.limitation.valueMapper` tag and set the `limitationType` attribute to Limitation type's identifier: ```yml -acme.security.limitation.custom_limitation.mapper: - class: 'AppBundle\Security\Limitation\Mapper\CustomLimitationValueMapper' +app.security.limitation.custom_limitation.mapper: + class: 'App\Security\Limitation\Mapper\CustomLimitationValueMapper' arguments: # ... tags: @@ -164,7 +164,7 @@ ezpublish: system: default: limitation_value_templates: - - { template: AppBundle:Limitation:custom_limitation_value.html.twig, priority: 0 } + - { template: limitation/custom_limitation_value.html.twig, priority: 0 } ``` diff --git a/docs/guide/design_engine.md b/docs/guide/design_engine.md index 24c0444369..254367bcce 100644 --- a/docs/guide/design_engine.md +++ b/docs/guide/design_engine.md @@ -14,12 +14,12 @@ For assets, the system uses the Symfony Asset component with asset packages. - **Theme**: A labeled collection of templates and assets. - Typically a directory containing templates. For example, templates located under `app/Resources/views/themes/my_theme` - or `src/AppBundle/Resources/views/themes/my_theme` are part of `my_theme` theme. + Typically a directory containing templates. For example, templates located under `templates/themes/my_theme` + are part of `my_theme` theme. !!! caution - After creating a new folder either in `app/Resources/views/themes/` or your bundle's `Resources/views/themes/` directory + After creating a new folder either in a project's or your bundle's `templates/themes/` directory you need to clear Symfony cache (`bin/console cache:clear`), even if you are working in the dev environment. - **Design**: A collection of themes. @@ -75,7 +75,6 @@ To define and use a design, you need to: Here is a simple example: ```yaml -# ezplatform.yml ezdesign: # You declare all available designs under "design_list". design_list: @@ -132,26 +131,26 @@ Using the `ezdesign` package will resolve current design with theme fallback. By convention, an asset theme directory can be located in: - `/Resources/public/themes/` -- `web/assets/themes/` +- `assets/themes/` Typical paths can be for example: - `/Resources/public/themes/foo/` => Assets will be part of the `foo` theme. - `/Resources/public/themes/bar/` => Assets will be part of the `bar` theme. -- `web/assets/themes/biz/` => Assets will be part of the `biz` theme. +- `assets/themes/biz/` => Assets will be part of the `biz` theme. -It is also possible to use `web/assets` as a global override directory. +It is also possible to use `assets` as a global override directory. If called asset is present **directly under this directory**, it will always be considered first. !!! caution You must have *installed* your assets with `assets:install` command, so that your public resources are - *installed* into the `web/` directory. + *installed* into the `assets/` directory. ### Fallback order The default fallback order is: -- Application assets directory: `web/assets/` -- Application theme directory: `web/assets/themes//` +- Application assets directory: `assets/` +- Application theme directory: `assets/themes//` - Bundle theme directory: `web/bundles//themes//` Calling `asset("js/foo.js", "ezdesign")` can for example be resolved to `web/bundles/app/themes/my_theme/js/foo.js`. @@ -170,7 +169,7 @@ In debug mode (e.g. `dev` environment), assets are being resolved at runtime. This behavior can, however, be controlled by the `disable_assets_pre_resolution` setting. ```yaml -# ezplatform_prod.yml +# ezplatform_prod.yaml ezdesign: # Force runtime resolution # Default value is '%kernel.debug%' @@ -180,12 +179,11 @@ ezdesign: ## Design usage with templates By convention, a theme directory must be located under `/Resources/views/themes/` or global -`app/Resources/views/themes/` directories. +`templates/themes/` directories. Typical paths can be for example: -- `app/Resources/views/themes/foo/` => Templates will be part of the `foo` theme. -- `app/Resources/views/themes/bar/` => Templates will be part of the `bar` theme. -- `src/AppBundle/Resources/views/themes/foo/` => Templates will be part of the `foo`theme. +- `templates/themes/foo/` => Templates will be part of the `foo` theme. +- `templates/themes/bar/` => Templates will be part of the `bar` theme. - `src/Acme/TestBundle/Resources/views/themes/the_best/` => Templates will be part of `the_best` theme. In order to use the configured design with templates, you need to use the **`@ezdesign`** special **Twig namespace**. @@ -223,7 +221,7 @@ The default fallback order is: !!! note - Bundle fallback order is the instantiation order in `AppKernel`. + Bundle fallback order is the instantiation order in `bundles.php`. #### Additional theme paths diff --git a/docs/guide/devops.md b/docs/guide/devops.md index 2e3784ccc6..80e9bc8dea 100644 --- a/docs/guide/devops.md +++ b/docs/guide/devops.md @@ -69,7 +69,7 @@ eZ Platform uses the [Monolog](https://github.com/Seldaek/monolog) component to According to [their documentation](https://seldaek.github.io/monolog/doc/02-handlers-formatters-processors.html#log-to-files-and-syslog), it "logs records to a file and creates one logfile per day. It will also delete files older than `$maxFiles`". -Monolog's handler can be configured in `app/config/config.yml`: +Monolog's handler can be configured in `config/packages//monolog.yaml`: ``` yaml monolog: diff --git a/docs/guide/environments.md b/docs/guide/environments.md index 6d48808a59..5677465181 100644 --- a/docs/guide/environments.md +++ b/docs/guide/environments.md @@ -22,8 +22,8 @@ SetEnvIf Request_URI ".*" SYMFONY_ENV="dev" If you want to use a custom environment (something other than `prod` and `dev`), you need to create the dedicated configuration files for your environment: -- `app/config/config_.yml` -- `app/config/ezplatform_.yml` +- `config/config_.yml` +- `config/ezplatform_.yml` The name used as `` is the one that can be used as value of the `ENVIRONMENT` variable. diff --git a/docs/guide/extending_ez_platform.md b/docs/guide/extending_ez_platform.md index 813b381dda..155090c953 100644 --- a/docs/guide/extending_ez_platform.md +++ b/docs/guide/extending_ez_platform.md @@ -110,7 +110,7 @@ class MenuListener implements EventSubscriberInterface } ``` -After creating a subscriber, add it to `app/config/services.yml`: +After creating a subscriber, add it to `config/services.yaml`: ``` yaml services: @@ -269,7 +269,7 @@ In the following example, the `DashboardEventSubscriber.php` reverses the order (in a default installation this makes the "Everyone" block appear above the "Me" block): ``` php -namespace AppBundle\EventListener; +namespace App\EventListener; use EzSystems\EzPlatformAdminUi\Component\Event\RenderGroupEvent; use Symfony\Component\EventDispatcher\EventSubscriberInterface; @@ -311,10 +311,10 @@ You can extend existing tab groups with new tabs, or create your own tab groups. To create a custom tab group with additional logic you need to create it at the level of compiling the Symfony container, using a [CompilerPass](https://symfony.com/doc/3.4/service_container/compiler_passes.html). -For example, in `src/AppBundle/DependencyInjection/Compiler/CustomTabGroupPass.php`: +For example, in `src/DependencyInjection/Compiler/CustomTabGroupPass.php`: ``` php -namespace AppBundle\DependencyInjection\Compiler; +namespace App\DependencyInjection\Compiler; use EzSystems\EzPlatformAdminUi\Tab\TabGroup; use EzSystems\EzPlatformAdminUi\Tab\TabRegistry; @@ -358,7 +358,7 @@ This will render the group and all tabs assigned to it. Before you add a tab to a group you must create the tab's PHP class and define it as a Symfony service with the `ezplatform.tab` tag: ``` yaml -AppBundle\Custom\Tab: +App\Custom\Tab: parent: EzSystems\EzPlatformAdminUi\Tab\AbstractTab tags: - { name: ezplatform.tab, group: custom-tab-group } @@ -370,10 +370,10 @@ This configuration also assigns the new tab to `custom-tab-group`. If the `custom-tab-group` does not yet exist, it will be created automatically at this point. -The tab class can look like this (in `src/AppBundle/Custom/Tab.php`): +The tab class can look like this (in `src/Custom/Tab.php`): ``` php -namespace AppBundle\Custom; +namespace App\Custom; use EzSystems\EzPlatformAdminUi\Tab\AbstractTab; @@ -625,7 +625,7 @@ A component is any class that implements the `Renderable` interface. It must be tagged as a service: ``` yaml -AppBundle\Component\MyNewComponent: +App\Component\MyNewComponent: tags: - { name: ezplatform.admin_ui.component, group: content-edit-form-before } ``` @@ -672,7 +672,7 @@ This renders the `path/to/file.html.twig` template with `first_param` and `secon With `LinkComponent` and `ScriptComponent` you provide `$href` and `$src` as arguments, respectively: ``` yaml -appbundle.components.my_link_component: +app.components.my_link_component: parent: EzSystems\EzPlatformAdminUi\Component\LinkComponent arguments: $href: 'http://address.of/file.css' @@ -681,7 +681,7 @@ appbundle.components.my_link_component: ``` ``` yaml -appbundle.components.my_script_component: +app.components.my_script_component: parent: EzSystems\EzPlatformAdminUi\Component\ScriptComponent arguments: $src: 'http://address.of/file.js' @@ -731,7 +731,7 @@ To use them, create an `src\AppBundle\Service\MyService.php` file containing: ``` php @@ -157,7 +157,7 @@ The configuration requires an `ezfactbox.html.twig` template for the custom tag {% endif %} ``` -To ensure the new tag has labels, provide translations in `app/Resources/translations/custom_tags.en.yaml` file: +To ensure the new tag has labels, provide translations in `translations/custom_tags.en.yaml` file: ```yaml # ezfactbox @@ -175,7 +175,7 @@ Custom tags can also be placed inline with the following configuration: ezrichtext: custom_tags: badge: - template: AppBundle:field_type/ezrichtext/custom_tag:badge.html.twig + template: field_type/ezrichtext/custom_tag/badge.html.twig icon: '/bundles/ezplatformadminui/img/ez-icons.svg#bookmark' is_inline: true attributes: @@ -228,7 +228,7 @@ The system expects two kinds of configuration: ### Translations Labels that appear for each custom style in the Online Editor need to be translated using Symfony translation system. -The translation domain is called `custom_styles`. For the code example above, you can do it in a `app/Resources/translations/custom_styles.en.yml` file: +The translation domain is called `custom_styles`. For the code example above, you can do it in a `translations/custom_styles.en.yaml` file: ```yaml ezrichtext.custom_styles.highlighted_block.label: Highlighted block @@ -241,19 +241,19 @@ The `template` key points to the template used to render the custom style. It is In the example above, the template files for the front end could be: -- `app/Resources/views/themes/standard/field_type/ezrichtext/custom_style/highlighted_word.html.twig`: +- `templates/themes/standard/field_type/ezrichtext/custom_style/highlighted_word.html.twig`: ``` html+twig {% spaceless %}{{ content|raw }}{% endspaceless %} ``` -- `app/Resources/views/themes/standard/field_type/ezrichtext/custom_style/highlighted_block.html.twig`: +- `templates/themes/standard/field_type/ezrichtext/custom_style/highlighted_block.html.twig`: ``` html+twig
{% spaceless %}{{ content|raw }}{% endspaceless %}
``` -Templates for Content View in the Back Office would be `app/Resources/views/themes/admin/field_type/ezrichtext/custom_style/highlighted_word.html.twig` and `app/Resources/views/themes/admin/field_type/ezrichtext/custom_style/highlighted_block.html.twig` respectively (assuming Admin SiteAccess uses the `admin` theme). +Templates for Content View in the Back Office would be `templates/themes/admin/field_type/ezrichtext/custom_style/highlighted_word.html.twig` and `templates/themes/admin/field_type/ezrichtext/custom_style/highlighted_block.html.twig` respectively (assuming Admin SiteAccess uses the `admin` theme). ## Plugins configuration diff --git a/docs/guide/extending_page.md b/docs/guide/extending_page.md index 6b8ac9f05c..a262a577ee 100644 --- a/docs/guide/extending_page.md +++ b/docs/guide/extending_page.md @@ -117,12 +117,12 @@ You can also use one of the [built-in Symfony types](https://symfony.com/doc/current/forms.html#built-in-field-types), e.g. `AbstractType` for any custom type or `IntegerType` for numeric types. - To define the type, create a file `src/AppBundle/Block/Attribute/MyStringAttributeType.php` that contains: + To define the type, create a file `src/Block/Attribute/MyStringAttributeType.php` that contains: ``` php hl_lines="5 6 15" render( 'AcmeTestBundle:Default:languages.html.twig', [ 'routeRef' => $routeRef ] ); + return $this->render( 'languages.html.twig', [ 'routeRef' => $routeRef ] ); } } ``` @@ -142,8 +142,6 @@ Another way of using multiple languages is setting up a separate SiteAccess for Configuration is not mandatory, but can help to distinguish which SiteAccesses can be considered *translation SiteAccesses*. ``` yaml -# ezplatform.yml - ezpublish: siteaccess: default_siteaccess: eng @@ -200,8 +198,6 @@ There are some cases where your SiteAccesses share settings (repository, content The solution is defining new groups: ``` yaml -# ezplatform.yml - ezpublish: siteaccess: default_siteaccess: eng diff --git a/docs/guide/limitations.md b/docs/guide/limitations.md index 7019f7af29..e60728b791 100644 --- a/docs/guide/limitations.md +++ b/docs/guide/limitations.md @@ -24,7 +24,7 @@ Currently this covers [Subtree of Location](limitation_reference.md#subtree-of-l !!! tip - Core Policies with Limitations are defined in [`EzPublishCoreBundle/Resources/config/policies.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/policies.yml). + Core Policies with Limitations are defined in [`EzPublishCoreBundle/settings/policies.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/policies.yml). Each function in one of the five modules (content, section, state, user, workflow) can be assigned different Limitations. diff --git a/docs/guide/multisite.md b/docs/guide/multisite.md index 93adcc8d8b..4ecfaf46b3 100644 --- a/docs/guide/multisite.md +++ b/docs/guide/multisite.md @@ -104,8 +104,6 @@ The Index Page is the page shown when the root index `/` is accessed. You can configure the Index Page separately for each SiteAccess. Place the parameter `index_page` in your `ezplatform.yml` file, under the correct SiteAccess: ``` yaml -# ezplatform.yml - ezpublish: system: event: diff --git a/docs/guide/persistence_cache.md b/docs/guide/persistence_cache.md index a13ae88ccb..7e03e35a7b 100644 --- a/docs/guide/persistence_cache.md +++ b/docs/guide/persistence_cache.md @@ -54,7 +54,7 @@ The underlying cache system is exposed as an `ezpublish.cache_pool` service, and ### Configuration -By default, configuration currently uses **FileSystem** to store cache files, which is defined in [`default_parameters.yml`](https://github.com/ezsystems/ezplatform/blob/master/app/config/default_parameters.yml#L34). +By default, configuration currently uses **FileSystem** to store cache files, which is defined in [`.env`](https://github.com/ezsystems/ezplatform/blob/master/.env). You can select a different cache backend and configure its parameters in the relevant file in the `cache_pool` folder. #### Multi Repository setup @@ -65,7 +65,6 @@ Then, in `ezplatform.yml` you can specify which cache pool you want to use on a The following example shows use in a SiteAccess group: ``` yaml -# ezplatform.yml site group setting ezpublish: system: # "site_group" refers to the group configured in site access @@ -124,7 +123,7 @@ Redis is used via [Redis pecl extension](https://pecl.php.net/package/redis). See [Redis Cache Adapter in Symfony documentation](https://symfony.com/doc/3.4/components/cache/adapters/redis_adapter.html#configure-the-connection) for information on how to configure Redis. -Out of the box in `app/config/cache_pool/cache.redis.yml` you'll find a default example that can be used. +Out of the box in `config/packages/cache_pool/cache.redis.yaml` you'll find a default example that can be used. !!! cloud "eZ Platform Cloud" @@ -147,7 +146,7 @@ services: namespace: 'ez' ``` -See `app/config/default_parameters.yml` and `app/config/cache_pool/cache.redis.yml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. +See `config/packages/ezplatform.yaml` and `config/packages/cache_pool/cache.redis.yaml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. !!! caution "Clearing Redis cache" @@ -189,13 +188,13 @@ For best performance we recommend use of Redis Sentinel if it fits your needs. H See [Memcached Cache Adapter in Symfony documentation](https://symfony.com/doc/3.4/components/cache/adapters/memcached_adapter.html#configure-the-connection) for information on how to configure Memcached. -Out of the box in `app/config/cache_pool/cache.memcached.yml` you'll find a default example that can be used. +Out of the box in `config/cache_pool/cache.memcached.yml` you'll find a default example that can be used. !!! cloud "eZ Platform Cloud" - For eZ Platform Cloud/Platform.sh: This is automatically configured in `app/config/env/platformsh.php` if you have enabled Memcached as `cache` Platform.sh service. + For eZ Platform Cloud/Platform.sh: This is automatically configured in `config/env/platformsh.php` if you have enabled Memcached as `cache` Platform.sh service. -For anything else, you can enable it with environment variables detected automatically by `app/config/env/generic.php`. +For anything else, you can enable it with environment variables detected automatically by `config/env/generic.php`. For instance, if you set the following environment variables `export CACHE_POOL="cache.memcached" CACHE_DSN="user:pass@localhost?weight=33"`, it will result in config like this: ``` yaml @@ -210,7 +209,7 @@ services: namespace: 'ez' ``` -See `app/config/default_parameters.yml` and `app/config/cache_pool/cache.memcached.yml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. +See `config/default_parameters.yml` and `config/cache_pool/cache.memcached.yml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. !!! caution "Clearing Memcached cache" diff --git a/docs/guide/richtext_block.md b/docs/guide/richtext_block.md index 27c6f3ae5e..8d5e963be9 100644 --- a/docs/guide/richtext_block.md +++ b/docs/guide/richtext_block.md @@ -3,9 +3,9 @@ !!! enterprise To create a richtext [custom Page block](extending_page.md), you need to define its layout, provide templates, add a subscriber and register it as a service. - - Start with creating an `app/config/layouts.yml` file containing: - + + Start with creating a `config/layouts.yaml` file containing: + ``` yaml hl_lines="3 15" ezplatform_page_fieldtype: blocks: @@ -15,47 +15,47 @@ configuration_template: blocks/my_block/config.html.twig views: default: - template: + template: name: My block view priority: -255 attributes: content: name: Content type: richtext - - ``` - + + ``` + This configuration defines a new block, its view and configuration templates, and attribute type `richtext` (line 15). Remember to provide an icon for the block in the `assets/images/blocks/` folder. - - Next, add `layouts.yml` to `app/config/config.yml` under the `imports` key: - + + Next, add `layouts.yaml` to `config/config.yaml` under the `imports` key: + ``` yaml imports: - resource: { layouts.yml } ``` - - Next, create a subscriber that converts a string of data into XML. - Create a `src/AppBundle/Event/Subscriber/RichTextBlockSubscriber.php` file containing: - + + Next, create a subscriber that converts a string of data into XML. + Create a `src/Event/Subscriber/RichTextBlockSubscriber.php` file containing: + ``` php hl_lines="32 41 42 43 44 45 46 47 48 49 50 51" domDocumentFactory = $domDocumentFactory; } - + /** * {@inheritdoc} */ @@ -73,7 +73,7 @@ BlockRenderEvents::getBlockPreRenderEventName('my_block') => 'onBlockPreRender', ]; } - + /** * @param \EzSystems\EzPlatformPageFieldType\FieldType\Page\Block\Renderer\Event\PreRenderEvent $event */ @@ -92,44 +92,44 @@ $renderRequest->setParameters($parameters); } } - + ``` - + Note that in the line 32, `my_block` is the name of the block defined in the `layouts.yml` file (line 3). This line also implements the `PreRender` method. Lines 41-51 handle the conversion of content into XML string. - + At this point you need to create [templates](/guide/templates.md#templating-basics) for displaying and configuring your block. - - Start with creating the view template in `app/Resources/views/blocks/my_block/richtext.html.twig`: - + + Start with creating the view template in `templates/blocks/my_block/richtext.html.twig`: + ``` html+twig hl_lines="2"
{{ document | richtext_to_html5 }}
- + ``` Here, line 2 is responsible for rendering the content from XML to HTML5. - - Proceed with creating a separate `app/Resources/views/blocks/my_block/config.html.twig` template: - + + Proceed with creating a separate `templates/blocks/my_block/config.html.twig` template: + ``` html+twig {% extends '@EzPlatformPageBuilder/page_builder/block/config.html.twig' %} - + {% block meta %} {{ parent() }} {% endblock %} - + ``` - + Complete the procedure with registering the subscriber as a service: - + ``` yaml services: AppBundle\Event\Subscriber\RichTextBlockSubscriber: tags: - { name: kernel.event_subscriber } ``` - + For details on customizing additional options of the block or creating custom blocks with other attribute types, see [Creating custom Page blocks](/guide/extending_page.md). diff --git a/docs/guide/search_engines.md b/docs/guide/search_engines.md index e3d9f73ac7..cb4b9fcd4c 100644 --- a/docs/guide/search_engines.md +++ b/docs/guide/search_engines.md @@ -12,7 +12,7 @@ Its connections are defined in the same way as for storage engine, and no furthe ### Configuring the Repository with the Legacy search engine -Search can be configured independently from storage, and the following configuration example (in `ezpublish.yml`) shows both the default values, and how you configure legacy as the search engine: +Search can be configured independently from storage, and the following configuration example shows both the default values, and how you configure legacy as the search engine: ``` yaml ezpublish: diff --git a/docs/guide/security.md b/docs/guide/security.md index 37fc03fc36..849d7d3253 100644 --- a/docs/guide/security.md +++ b/docs/guide/security.md @@ -6,7 +6,7 @@ ## Symfony authentication -To use Symfony authentication with eZ Platform, use the following configuration (in `app/config/security.yml`): +To use Symfony authentication with eZ Platform, use the following configuration (in `config/packages/security.yaml`): ``` yaml security: @@ -19,7 +19,7 @@ security: logout: ~ ``` -And in `app/config/routing.yml`: +And in `config/packages/routing.yaml`: ``` yaml login: @@ -50,15 +50,15 @@ A `SecurityController` is used to manage all security-related actions and is thu The base template used is [`EzPublishCoreBundle:Security:login.html.twig`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/views/Security/login.html.twig). -The layout used by default is `%ezpublish.content_view.viewbase_layout%` (empty layout) but can be configured together with the login template (in `ezplatform.yml`): +The layout used by default is `%ezpublish.content_view.viewbase_layout%` (empty layout) but can be configured together with the login template: ``` yaml ezpublish: system: my_siteaccess: user: - layout: AcmeTestBundle::layout.html.twig - login_template: AcmeTestBundle:User:login.html.twig + layout: layout.html.twig + login_template: user/login.html.twig ``` ##### Redirection after login diff --git a/docs/guide/sessions.md b/docs/guide/sessions.md index 3d7ad1003a..0cd5c4c001 100644 --- a/docs/guide/sessions.md +++ b/docs/guide/sessions.md @@ -25,7 +25,7 @@ so you can also define session configuration per SiteAccess and SiteAccess group ### Session options per SiteAccess -All site-related session configuration can be defined per SiteAccess and SiteAccess group (in `ezplatform.yml`): +All site-related session configuration can be defined per SiteAccess and SiteAccess group: ``` yaml ezpublish: @@ -55,7 +55,7 @@ Symfony can be configured to use custom handlers, or just fall back to what is eZ Platform adapts Symfony's defaults to make sure its session save path is always taken into account: ``` yaml -# Default config.yml session configuration +# Default session configuration framework: session: # handler_id can be set to null (~) like default in Symfony, if it so will use default session handler from php.ini @@ -80,7 +80,7 @@ See [shared sessions in the clustering guide](clustering.md#shared-sessions). To set up eZ Platform using [Memcached](https://pecl.php.net/package/memcached) you need to: - [Configure the session save handler settings in `php.ini`](http://php.net/manual/en/memcached.sessions.php) -- Set `%ezplatform.session.handler_id%` to `~` (null_ in `app/config/parameter.yml` +- Set `%ezplatform.session.handler_id%` to `~` (null) in `config/packages/ezplatform.yaml` Alternatively if you need to configure Memcached servers dynamically: @@ -105,7 +105,7 @@ session locking. To set up eZ Platform using the [Redis](https://pecl.php.net/package/redis) you need to: - [Configure the session save handler settings in `php.ini`](https://github.com/phpredis/phpredis/#php-session-handler) -- Set `%ezplatform.session.handler_id%` to `~` _(null)_ in `app/config/parameter.yml` +- Set `%ezplatform.session.handler_id%` to `~` _(null)_ in `config/packages/ezplatform.yaml` Alternatively if you have needs to configure Redis servers dynamically: @@ -114,7 +114,7 @@ Alternatively if you have needs to configure Redis servers dynamically: !!! note - For eZ Platform Cloud (and Platform.sh), this is already configured in `app/config/env/platformsh.php` based on `.platform.yml` config. + For eZ Platform Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yml` config. If you are on `php-redis` v4.2.0 and higher, you can optionally tweak [`php-redis` settings](https://github.com/phpredis/phpredis#session-locking) for session locking. diff --git a/docs/guide/signalslots.md b/docs/guide/signalslots.md index edaa84ece7..fb485673c1 100644 --- a/docs/guide/signalslots.md +++ b/docs/guide/signalslots.md @@ -207,7 +207,7 @@ All you need to do is to implement an event listener or subscriber and register This very simple example will just log the received signal. -In `services.yml` (in your bundle): +In `services.yml`: ``` yaml services: diff --git a/docs/guide/siteaccess.md b/docs/guide/siteaccess.md index 89e4249995..4b5b5a04d7 100644 --- a/docs/guide/siteaccess.md +++ b/docs/guide/siteaccess.md @@ -132,7 +132,7 @@ List of interfaces where you can apply SiteAccess names: You can also translate SiteAccess names. Displayed names depend on the selected language of the administration interface. -To define translation you need to put them in YAML file with correct language code e.g. `app/Resources/translations/ezplatform_siteaccess.en.yml`: +To define translation you need to put them in YAML file with correct language code e.g. `translations/ezplatform_siteaccess.en.yaml`: ```yaml en: Tasteful Planet @@ -187,10 +187,9 @@ SiteAccess matching is done through `eZ\Publish\MVC\SiteAccess\Matcher` objects To be usable, every SiteAccess must be provided a matcher. -You can configure SiteAccess matching in your main `app/config/ezplatform.yml`: +You can configure SiteAccess matching in your main `config/packages/ezplatform.yaml`: ``` yaml -# ezplatform.yml ezpublish: siteaccess: default_siteaccess: ezdemo_site @@ -466,7 +465,6 @@ They are based on logical combinations, or/and, using logical compound matchers: Each compound matcher will specify two or more sub-matchers. A rule will match if all the matchers combined with the logical matcher are positive. The example above would have used `Map\Host` and `Map\Uri`, combined with a `LogicalAnd`. When both the URI and host match, the SiteAccess configured with "match" is used. ``` yaml -# ezplatform.yml ezpublish: siteaccess: match: @@ -579,7 +577,7 @@ This allows you to link different resources referenced in the same content repos See [ez\_urlalias](twig_functions_reference.md#ez_urlalias) for more information about linking to a Location. ``` php -namespace Acme\TestBundle\Controller; +namespace App\Controller; use eZ\Bundle\EzPublishCoreBundle\Controller as BaseController; use Symfony\Component\Routing\Generator\UrlGeneratorInterface; @@ -654,8 +652,8 @@ Let's define a simple service which depends on the Repository's ContentService a ```yaml services: - acme.test.my_service: - class: Acme\AcmeTestBundle\MyService + app.test.my_service: + class: App\MyService arguments: ['@ezpublish.api.service.content'] calls: - [setSiteAccess, ['@ezpublish.siteaccess']] @@ -663,7 +661,7 @@ services: ```php .pagelayout` setting. This template will be used by default for those parts of the website where no other templates are defined. -A `pagelayout.html.twig` file exists already in Demo Bundles, but if you are using a clean installation, you need to create it from scratch. This file is typically located in a bundle, for example using the built-in AppBundle: `src/AppBundle/Resources/views`. The name of the bundle must the added whenever the file is called, like in the example below. +A `pagelayout.html.twig` file exists already in Demo Bundles, but if you are using a clean installation, you need to create it from scratch. This file is typically located in the `templates` folder. Any further templates will extend and modify this one, so they need to start with a line like this: ``` html+twig -{% extends "AppBundle::pagelayout.html.twig" %} +{% extends "pagelayout.html.twig" %} ``` -!!! note - - Although using AppBundle is recommended, you could also place the template files directly in `/app/Resources/views`. Then the files could be referenced in code without any prefix. - -!!! tip "Template paths" - - In short, the `Resources/views` part of the path is automatically added whenever a template file is referenced. What you need to provide is the bundle name, name of any subfolder within `/views/`, and file name, all three separated by colons (:) - - To find out more about the way of referencing template files placed in bundles, see [Referencing Templates in a Bundle](http://symfony.com/doc/current/book/templating.html#referencing-templates-in-a-bundle) in Symfony documentation. - Templates can be extended using a Twig [`block`](http://twig.sensiolabs.org/doc/functions/block.html) tag. This tag lets you define a named section in the template that will be filled in by the child template. For example, you can define a "title" block in the main template. Any child template that extends it can also contain a "title" block. In this case the contents of the block from the child template will be placed inside this block in the parent template (and override what was inside this block): ``` html+twig @@ -131,7 +121,7 @@ Templates can be extended using a Twig [`block`](http://twig.sensiolabs.org/doc/ ``` html+twig -{% extends "AppBundle::pagelayout.html.twig" %} +{% extends "pagelayout.html.twig" %} {% block title %}

Specific title

{% endblock %} @@ -163,7 +153,7 @@ This renders the value of the Field with identifier "description" of the current {{ ez_render_field( content, 'description', - { 'template': 'AppBundle:fields:description.html.twig' } + { 'template': 'fields/description.html.twig' } ) }} ``` @@ -181,7 +171,7 @@ This example renders the Content item with Location ID 33 using the line view. T #### Assets -Asset files such as CSS stylesheets, JS scripts or image files can be defined in the templates and need to be included in the directory structure in the same way as with any other web project. Assets are placed in the `web/` folder in your installation. +Asset files such as CSS stylesheets, JS scripts or image files can be defined in the templates and need to be included in the directory structure in the same way as with any other web project. Assets are placed in the `public/` folder in your installation. Instead of linking to stylesheets or embedding images like usually, you can use the [`asset`](http://symfony.com/doc/current/book/templating.html#linking-to-assets) function. @@ -407,7 +397,7 @@ The following example injects `my_variable` and `my_array` variables in all cont ``` php .url_checker`. -Example configuration (in `/app/config/ezplatform.yml`): +Example configuration (in `config/packages/ezplatform.yaml`): ```yml ezpublish: @@ -113,7 +113,7 @@ and register it with an `ezpublish.url_handler` tag. For instance: ```yaml app.url_checker.handler.custom: - class: 'AppBundle\URLChecker\Handler\CustomHandler' + class: 'App\URLChecker\Handler\CustomHandler' ... tags: - { name: ezpublish.url_handler, scheme: custom } diff --git a/docs/guide/user_management.md b/docs/guide/user_management.md index 10c1dbf99c..ed214a5b2a 100644 --- a/docs/guide/user_management.md +++ b/docs/guide/user_management.md @@ -11,7 +11,7 @@ To change password, the user must have the `user/password` permission. When the user requests a reset of a forgotten password, an email is sent to them with a token. It allows them to create a new password. -The template for this email is located in `/Resources/views/Security/mail/forgot_user_password.html.twig` in `ezsystems/ezplatform-user`. +The template for this email is located in `templates/Security/mail/forgot_user_password.html.twig` in `ezsystems/ezplatform-user`. You can customize it according to your needs. The validity of the password recovery token can be set using the `ezpublish.system..security.token_interval_spec` parameter. @@ -49,7 +49,7 @@ ezpublish: confirmation: user/registration_confirmation.html.twig ``` -With this configuration you place the templates in `app/Resources/views/user/registration_form.html.twig` and `app/Resources/views/user/registration_confirmation.html.twig`. +With this configuration you place the templates in `templates/user/registration_form.html.twig` and `templates/user/registration_confirmation.html.twig`. Here are default templates that you can reuse and/or modify: From 1dc1fd467df9a229980154b99069955474fdf4e9 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Tue, 4 Jun 2019 14:20:01 +0200 Subject: [PATCH 4/9] Change .yml extension to .yaml --- docs/api/extending_the_rest_api.md | 14 ++++++------- docs/api/field_type_reference.md | 2 +- docs/api/field_type_search.md | 4 ++-- docs/api/field_type_storage.md | 6 +++--- docs/api/field_type_type_and_value.md | 2 +- docs/api/graphql_customization.md | 8 ++++---- docs/api/public_php_api_customization.md | 10 +++++----- docs/api/rest_api_guide.md | 2 +- .../support_maintenance_faq.md | 2 +- .../creating_custom_rest_api_response.md | 2 +- .../displaying_children_of_a_content_item.md | 4 ++-- ...isplaying_content_with_simple_templates.md | 2 +- ...ess_aware_configuration_for_your_bundle.md | 14 ++++++------- .../importing_settings_from_a_bundle.md | 16 +++++++-------- docs/cookbook/sending_notifications.md | 2 +- .../setting_up_multi_language_siteaccesses.md | 12 +++++------ docs/guide/bundles.md | 2 +- docs/guide/config_back_office.md | 2 +- docs/guide/config_dynamic.md | 2 +- docs/guide/config_repository.md | 6 +++--- docs/guide/configuration.md | 10 +++++----- docs/guide/content_rendering.md | 2 +- docs/guide/custom_policies.md | 2 +- docs/guide/devops.md | 2 +- docs/guide/environments.md | 8 ++++---- docs/guide/extending_modules.md | 2 +- docs/guide/extending_online_editor.md | 4 ++-- docs/guide/extending_page.md | 4 ++-- docs/guide/http_cache.md | 6 +++--- docs/guide/images.md | 2 +- docs/guide/internationalization.md | 6 +++--- docs/guide/multisite.md | 6 +++--- docs/guide/performance.md | 2 +- docs/guide/persistence_cache.md | 10 +++++----- docs/guide/personalization.md | 20 +++++++++---------- docs/guide/richtext_block.md | 4 ++-- docs/guide/security.md | 4 ++-- docs/guide/sessions.md | 2 +- docs/guide/signalslots.md | 4 ++-- docs/guide/siteaccess.md | 2 +- docs/guide/solr.md | 4 ++-- docs/guide/templates.md | 8 ++++---- .../migrating_from_ez_publish_platform.md | 16 +++++++-------- docs/releases/earlier_releases.md | 4 ++-- .../ez_platform_16.02_release_notes.md | 4 ++-- .../ez_platform_v1.5.0_release_notes.md | 2 +- docs/releases/ez_platform_v2.2.0.md | 2 +- docs/releases/ez_platform_v2.4.md | 6 +++--- .../releases/ez_studio_16.02_release_notes.md | 6 +++--- docs/releases/updating_ez_platform.md | 8 ++++---- .../1_get_a_starter_website.md | 12 +++++------ .../2_prepare_the_landing_page.md | 8 ++++---- .../3_use_existing_blocks.md | 10 +++++----- .../4_create_a_custom_block.md | 4 ++-- .../extending_admin_ui/1_creating_a_bundle.md | 2 +- .../2_creating_a_dashboard_tab.md | 2 +- .../3_creating_a_content_list.md | 6 +++--- .../4_filtering_the_content_list.md | 2 +- .../5_creating_a_udw_tab.md | 4 ++-- .../6_adding_a_custom_tag.md | 8 ++++---- .../field_type/1_create_the_bundle.md | 2 +- .../3_implement_the_tweet_type_class.md | 2 +- .../4_register_the_field_type_as_a_service.md | 14 ++++++------- ...ent_the_legacy_storage_engine_converter.md | 2 +- .../field_type/6_introduce_a_template.md | 4 ++-- ...ng_and_editing_the_field_in_back_office.md | 2 +- .../field_type/8_add_a_validation.md | 4 ++-- .../3_customize_the_front_page.md | 4 ++-- .../4_display_a_list_of_content_items.md | 2 +- .../5_improve_configuration.md | 14 ++++++------- .../platform_beginner/6_embed_content.md | 6 +++--- .../7_enable_account_registration.md | 4 ++-- 72 files changed, 197 insertions(+), 197 deletions(-) diff --git a/docs/api/extending_the_rest_api.md b/docs/api/extending_the_rest_api.md index eb0a698540..0ef2c5b733 100644 --- a/docs/api/extending_the_rest_api.md +++ b/docs/api/extending_the_rest_api.md @@ -44,7 +44,7 @@ As mentioned earlier, your REST routes are required to use the REST URI prefix. ``` yaml myRestBundle_rest_routes: - resource: '@MyRestBundle/Resources/config/routing_rest.yml' + resource: '@MyRestBundle/Resources/config/routing_rest.yaml' prefix: '%ezpublish_rest.path_prefix%' ``` @@ -52,7 +52,7 @@ Using a distinct file for REST routes allows you to use the prefix for all this Next, you need to create the REST route. Define the route's [controller as a service](http://symfony.com/doc/current/cookbook/controller/service.html) since your controller was defined as such. -**My/Bundle/RestBundle/Resources/config/routing\_rest.yml** +**My/Bundle/RestBundle/Resources/config/routing\_rest.yaml** ``` yaml myRestBundle_hello_world: @@ -64,7 +64,7 @@ myRestBundle_hello_world: Due to [EZP-23016](https://jira.ez.no/browse/EZP-23016) - Custom REST API routes (v2) are not accessible from the legacy backend, custom REST routes must be prefixed with `ezpublish_rest_`, or they won't be detected correctly. -**My/Bundle/RestBundle/Resources/config/services.yml** +**My/Bundle/RestBundle/Resources/config/services.yaml** ``` yaml services: @@ -122,7 +122,7 @@ A `ValueObjectVisitor` will take a Value returned by a REST controller, whatever Create the service for your `ValueObjectVisitor` first. -**My/Bundle/RestBundle/Resources/config/services.yml** +**My/Bundle/RestBundle/Resources/config/services.yaml** ``` yaml services: @@ -208,9 +208,9 @@ Let's see what it would look like with a Content-Type of `application/vnd.my.Gre ``` -First, you need to create a service with the appropriate tag in `services.yml`. +First, you need to create a service with the appropriate tag in `services.yaml`. -**My/Bundle/RestBundle/Resources/config/services.yml** +**My/Bundle/RestBundle/Resources/config/services.yaml** ``` yaml services: @@ -280,7 +280,7 @@ use EzSystems\EzPlatformRest\Message; The `inputDispatcher` is responsible for matching the `Content-Type` sent in the header with the Greetings `InputParser` class. -Finally, a new Route should be added to `routing_rest.yml` +Finally, a new Route should be added to `routing_rest.yaml` ``` yaml myRestBundle_hello_world_using_post: diff --git a/docs/api/field_type_reference.md b/docs/api/field_type_reference.md index 75266b5875..f88294fb1e 100644 --- a/docs/api/field_type_reference.md +++ b/docs/api/field_type_reference.md @@ -1424,7 +1424,7 @@ Example: Example use: ``` yaml -# ezplatform.yml +# ezplatform.yaml ezpublish: system: site_group: diff --git a/docs/api/field_type_search.md b/docs/api/field_type_search.md index f06dfbcda2..2d260aacf4 100644 --- a/docs/api/field_type_search.md +++ b/docs/api/field_type_search.md @@ -32,7 +32,7 @@ This method gets name of the default field to be used for sorting. As Field Type ## Register Indexable Implementations -Implement `eZ\Publish\SPI\FieldType\Indexable` as an extra service and register this Service using the `ezpublish.fieldType.indexable` tag. Example from [`indexable_fieldtypes.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/indexable_fieldtypes.yml): +Implement `eZ\Publish\SPI\FieldType\Indexable` as an extra service and register this Service using the `ezpublish.fieldType.indexable` tag. Example from [`indexable_fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/indexable_fieldtypes.yaml): ``` yml ezpublish.fieldType.indexable.ezkeyword: @@ -83,7 +83,7 @@ The default available search Field Types that can be found in the `eZ\Publish\SP As mentioned before, if you use the standard type definitions, there is no need to configure the search backend in any way. The Field definitions are handled using `dynamicField` definitions in Solr, for example. -If you want to configure the handling of your field, you can always add a special field definition to the Solr `schema.xml`. For fields, the Field Type names used by the Solr search backend look like this: `//_`. +If you want to configure the handling of your field, you can always add a special field definition to the Solr `schema.xml`. For fields, the Field Type names used by the Solr search backend look like this: `//_`. You can define custom `dynamicField` definitions to match, for example, on your custom `_` definition. You could also define a custom Field definition for certain fields, like for the name Field in an article: diff --git a/docs/api/field_type_storage.md b/docs/api/field_type_storage.md index 33b7db9586..cf9e5fc26d 100644 --- a/docs/api/field_type_storage.md +++ b/docs/api/field_type_storage.md @@ -59,7 +59,7 @@ The tag has the following attribute: !!! tip - Converter configuration for built-in Field Types is located in [`eZ/Publish/Core/settings/fieldtype_external_storages.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yml). + Converter configuration for built-in Field Types is located in [`eZ/Publish/Core/settings/fieldtype_external_storages.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yaml). ## Storing external data @@ -132,7 +132,7 @@ services: The configuration requires providing the `ezpublish.fieldType.externalStorageHandler` tag, with the `alias` attribute being the *fieldTypeIdentifier*. You also have to inject the gateway in `arguments`, [see below](#gateway-based-storage). -External storage configuration for basic Field Types is located in [eZ/Publish/Core/settings/fieldtype_external_storages.yml](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yml). +External storage configuration for basic Field Types is located in [eZ/Publish/Core/settings/fieldtype_external_storages.yaml](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yaml). #### Registration @@ -155,4 +155,4 @@ Also note that there can be several gateways per Field Type (one per storage eng !!! tip - Gateway configuration for built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/storage_engines.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage_engines.yml). + Gateway configuration for built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/storage_engines.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage_engines.yaml). diff --git a/docs/api/field_type_type_and_value.md b/docs/api/field_type_type_and_value.md index 5f5d95b65d..d37abc800f 100644 --- a/docs/api/field_type_type_and_value.md +++ b/docs/api/field_type_type_and_value.md @@ -124,7 +124,7 @@ The `alias` key is the `fieldTypeIdentifier`. !!! tip - The configuration of built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/fieldtypes.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Publish/Core/settings/fieldtypes.yml). + The configuration of built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Publish/Core/settings/fieldtypes.yaml). ## Field Type settings diff --git a/docs/api/graphql_customization.md b/docs/api/graphql_customization.md index ec6463fb95..5ca93b0ae0 100644 --- a/docs/api/graphql_customization.md +++ b/docs/api/graphql_customization.md @@ -6,7 +6,7 @@ You can customize the GraphQL schema that is generated from your repository. You can use it if your application requires custom GraphQL resources, for instance for Doctrine entities. -To do so, create an `app/config/graphql/Query.types.yml` file. It will be used as the GraphQL query root. +To do so, create an `app/config/graphql/Query.types.yaml` file. It will be used as the GraphQL query root. In that file, add new fields that use any custom type or custom logic you require, based on [overblog/GraphQLBundle](https://github.com/overblog/GraphQLBundle). @@ -17,7 +17,7 @@ You can include the eZ Platform schema in two ways: either through inheritance o #### Inheritance -To use inheritance, apply the following configuration in `app/config/graphql/Query.types.yml`: +To use inheritance, apply the following configuration in `app/config/graphql/Query.types.yaml`: ``` yaml Query: @@ -33,7 +33,7 @@ Query: #### Composition To use composition, define eZ Platform schema as a field in your custom schema. -For example, in `app/config/graphql/Query.types.yml`: +For example, in `app/config/graphql/Query.types.yaml`: ``` yaml Query: @@ -49,7 +49,7 @@ Query: ### Custom mutations Custom mutations are created in the same way as custom query configuration. -An `app/config/graphql/Mutation.types.yml` file will be used as the source for mutation definitions in your schema. +An `app/config/graphql/Mutation.types.yaml` file will be used as the source for mutation definitions in your schema. ``` yaml Mutation: diff --git a/docs/api/public_php_api_customization.md b/docs/api/public_php_api_customization.md index 8e07bf0acc..ee71cc1a8d 100644 --- a/docs/api/public_php_api_customization.md +++ b/docs/api/public_php_api_customization.md @@ -210,13 +210,13 @@ Hello world In this short chapter, you will see how to create a new route that will catch a custom URL and execute a controller action. You will create a new route, `/cookbook/test`, that displays a simple 'Hello world' message. This tutorial is a simplified version of the official one that can be found on . -During your bundle's generation, you have chosen to generate the bundle with default code snippets. Fortunately, almost everything you need is part of those snippets. You just need to do some editing, in particular in two locations: `src/EzSystems/Resources/CookbookBundle/config/routing.yml` and `src/EzSystems/CookbookBundle/Controllers/DefaultController.php`. The first one will be used to configure your route (`/cookbook/test`) as well as the controller action the route should execute, while the latter will contain the actual action's code. +During your bundle's generation, you have chosen to generate the bundle with default code snippets. Fortunately, almost everything you need is part of those snippets. You just need to do some editing, in particular in two locations: `src/EzSystems/Resources/CookbookBundle/config/routing.yaml` and `src/EzSystems/CookbookBundle/Controllers/DefaultController.php`. The first one will be used to configure your route (`/cookbook/test`) as well as the controller action the route should execute, while the latter will contain the actual action's code. -### routing.yml +### routing.yaml This is the file where you define your action's URL matching. The generated file contains this YAML block: -**Generated routing.yml** +**Generated routing.yaml** ``` yaml ez_systems_cookbook_homepage: @@ -226,7 +226,7 @@ ez_systems_cookbook_homepage: You can safely remove this default code, and replace it with this: -**Edited routing.yml** +**Edited routing.yaml** ``` yaml ezsystems_cookbook_hello: @@ -251,7 +251,7 @@ public function helloAction( $name ) } ``` - This method receives the parameter defined in `routing.yml`. It is called "name" in the route definition, and must be called $name in the matching action. Since the action is named "hello" in `routing.yml`, the expected method name is `helloAction`. + This method receives the parameter defined in `routing.yaml`. It is called "name" in the route definition, and must be called $name in the matching action. Since the action is named "hello" in `routing.yaml`, the expected method name is `helloAction`. Controller actions **must** return a Response object that will contain the response's content, the headers, and various optional properties that affect the action's behavior. In your case, you simply set the content, using `setContent()`, to "Hello $name". Go to , and you should get "Hello YourName". diff --git a/docs/api/rest_api_guide.md b/docs/api/rest_api_guide.md index ebacb7b3f1..1a5262ee99 100644 --- a/docs/api/rest_api_guide.md +++ b/docs/api/rest_api_guide.md @@ -72,7 +72,7 @@ As explained in more detail in the [authentication page](general_rest_usage.md#r To enable basic auth based authentication, you need to edit `config/packages/security.yaml` and uncomment the configuration block about REST -**security.yml** +**security.yaml** ```yaml security: diff --git a/docs/community_resources/support_maintenance_faq.md b/docs/community_resources/support_maintenance_faq.md index d1f660cc41..1f794b2881 100644 --- a/docs/community_resources/support_maintenance_faq.md +++ b/docs/community_resources/support_maintenance_faq.md @@ -103,7 +103,7 @@ e.g. configuration for Landing Page Blocks could be placed in `landing_page_bloc ```yaml imports: - - { resource: landing_page_blocks.yml } + - { resource: landing_page_blocks.yaml } ``` #### How can I implement authentication in an eZ Platform-based project? diff --git a/docs/cookbook/creating_custom_rest_api_response.md b/docs/cookbook/creating_custom_rest_api_response.md index 51a9faaed0..87c9235450 100644 --- a/docs/cookbook/creating_custom_rest_api_response.md +++ b/docs/cookbook/creating_custom_rest_api_response.md @@ -161,7 +161,7 @@ class AppBundle extends Bundle ## Configuration -The last thing you need to do is to set a configuration which should be located in the `services.yml` file of your bundle. +The last thing you need to do is to set a configuration which should be located in the `services.yaml` file of your bundle. The important part are the keys: - `app.rest.output.visitor.json.regexps` which helps identifying proper header diff --git a/docs/cookbook/displaying_children_of_a_content_item.md b/docs/cookbook/displaying_children_of_a_content_item.md index 9e1cc9b3ca..2fa44ea84e 100644 --- a/docs/cookbook/displaying_children_of_a_content_item.md +++ b/docs/cookbook/displaying_children_of_a_content_item.md @@ -77,7 +77,7 @@ This template makes use of the `items` specified in `assign_results_to` to list There are three different ways of using a Custom Controller that you can learn about in the [Custom Controller section](../guide/controllers.md#custom-rendering-logic). In this case we will be applying the first of these, that is using the Custom Controller alongside the built-in ViewController. -Configuring for the use of a Custom Controller starts with pointing to it in your standard view configuration (which you can keep in `ezplatform.yml` or a separate file, for example `views.yml`): +Configuring for the use of a Custom Controller starts with pointing to it in your standard view configuration (which you can keep in `ezplatform.yaml` or a separate file, for example `views.yaml`): ``` yaml folder: @@ -198,7 +198,7 @@ class Children } ``` -Next, you must register these two services in `config/services.yml`: +Next, you must register these two services in `config/services.yaml`: ``` yaml services: diff --git a/docs/cookbook/displaying_content_with_simple_templates.md b/docs/cookbook/displaying_content_with_simple_templates.md index 3dc9b42217..19b9a26408 100644 --- a/docs/cookbook/displaying_content_with_simple_templates.md +++ b/docs/cookbook/displaying_content_with_simple_templates.md @@ -22,7 +22,7 @@ Now you need a config that will decide when this template is used. You can place the config in the `config` folder in either of two places: a separate file or the preexisting `ezplatform.yaml`. In this case you'll use the latter. -In `ezplatform.yml` under the `ezpublish` and `system` keys add the following config (pay attention to indentation. `default` should be indented relative to `system`): +In `ezplatform.yaml` under the `ezpublish` and `system` keys add the following config (pay attention to indentation. `default` should be indented relative to `system`): ``` yaml # 'default' is the SiteAccess. diff --git a/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md b/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md index 8d1218e916..c825ab0da5 100644 --- a/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md +++ b/docs/cookbook/exposing_siteaccess_aware_configuration_for_your_bundle.md @@ -17,7 +17,7 @@ The goal of this feature is to make it easy to implement a SiteAccess-aware sem ## Semantic configuration parsing -An abstract `Configuration` class has been added, simplifying the way to add a SiteAccess settings tree like the following in `ezplatform.yml`: +An abstract `Configuration` class has been added, simplifying the way to add a SiteAccess settings tree like the following in `ezplatform.yaml`: ``` yaml acme_example: @@ -105,7 +105,7 @@ class AcmeExampleExtension extends Extension $config = $this->processConfiguration($configuration, $configs); $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); - $loader->load( 'default_settings.yml' ); + $loader->load( 'default_settings.yaml' ); // "acme_example" will be the namespace as used in ConfigResolver format. $processor = new ConfigurationProcessor($container, 'acme_example'); @@ -142,7 +142,7 @@ class AcmeExampleExtension extends Extension Always ensure you have defined and loaded default settings. -In `@AcmeExampleBundle/Resources/config/default_settings.yml`: +In `@AcmeExampleBundle/Resources/config/default_settings.yaml`: ``` yaml parameters: @@ -161,7 +161,7 @@ When you define a hash as semantic config, you sometimes don't want the SiteAcce but *enrich* them by appending new entries. This is made possible by using `$processor->mapConfigArray()`, which needs to be called outside the closure (before or after), in order to be called only once. -Consider the following default config in `default_settings.yml`: +Consider the following default config in `default_settings.yaml`: ``` yaml parameters: @@ -173,7 +173,7 @@ parameters: language: php ``` -And then this semantic config in `ezplatform.yml`: +And then this semantic config in `ezplatform.yaml`: ``` yaml acme_example: @@ -209,7 +209,7 @@ In the example above, entries were merged in respect to the scope order of prece You can add another level by passing `ContextualizerInterface::MERGE_FROM_SECOND_LEVEL` as an option (third argument) to`$contextualizer->mapConfigArray()`. -In `default_settings.yml`: +In `default_settings.yaml`: ``` yaml parameters: @@ -221,7 +221,7 @@ parameters: language: [php] ``` -Semantic config (`ezplatform.yml` / `config.yml`): +Semantic config (`ezplatform.yaml` / `config.yaml`): ``` yaml acme_example: diff --git a/docs/cookbook/importing_settings_from_a_bundle.md b/docs/cookbook/importing_settings_from_a_bundle.md index 614bc050c6..41ca8dbce2 100644 --- a/docs/cookbook/importing_settings_from_a_bundle.md +++ b/docs/cookbook/importing_settings_from_a_bundle.md @@ -6,19 +6,19 @@ When developing your website it is best practice to use one or several custom bundles. However, dealing with core bundle semantic configuration can be a bit tedious -if you maintain it in the main `ezplatform.yaml` configuration file. +if you maintain it in the main `templates/ezplatform.yml` configuration file. This page shows how to import configuration from a bundle in two ways: the manual way and the implicit way. ## Importing settings manually Importing manually is the simpler of the two ways and has the advantage of being explicit. -It relies on using the `imports` statement in your main `ezplatform.yml`: +It relies on using the `imports` statement in your main `ezplatform.yaml`: ``` yaml imports: # Import the template selection rules that reside in your custom AcmeExampleBundle. - - {resource: "@AcmeExampleBundle/Resources/config/templates_rules.yml"} + - {resource: "@AcmeExampleBundle/Resources/config/templates_rules.yaml"}   ezpublish: # ... @@ -49,7 +49,7 @@ ezpublish: !!! tip - If you want to import configuration for development use only, you can do so in `ezplatform_dev.yml`  + If you want to import configuration for development use only, you can do so in `ezplatform_dev.yaml`  ## Importing settings implicitly @@ -60,7 +60,7 @@ This assumes you have knowledge of [service container extensions](http://symfony !!! note - Configuration loaded this way will be overridden by the main `ezplatform.yml` file. + Configuration loaded this way will be overridden by the main `ezplatform.yaml` file. In `Acme/ExampleBundle/DependencyInjection/AcmeExampleExtension`: @@ -96,17 +96,17 @@ class AcmeExampleExtension extends Extension implements PrependExtensionInterfac public function prepend( ContainerBuilder $container ) { // Loading your YAML file containing template rules - $configFile = __DIR__ . '/../Resources/config/template_rules.yml'; + $configFile = __DIR__ . '/../Resources/config/template_rules.yaml'; $config = Yaml::parse( file_get_contents( $configFile ) ); // Explicitly prepend loaded configuration for "ezpublish" namespace. - // It will be placed under the "ezpublish" configuration key, like in ezplatform.yml. + // It will be placed under the "ezpublish" configuration key, like in ezplatform.yaml. $container->prependExtensionConfig( 'ezpublish', $config ); $container->addResource( new FileResource( $configFile ) ); } } ``` -In `AcmeExampleBundle/Resources/config/template_rules.yml`: +In `AcmeExampleBundle/Resources/config/template_rules.yaml`: ``` yaml # You explicitly prepended config for "ezpublish" namespace in the service container extension,  diff --git a/docs/cookbook/sending_notifications.md b/docs/cookbook/sending_notifications.md index c281bd60f8..f52644f071 100644 --- a/docs/cookbook/sending_notifications.md +++ b/docs/cookbook/sending_notifications.md @@ -176,7 +176,7 @@ You can add the template that is defined above in the `render()` method to one o ``` -Finally, you need to add an entry to `services.yml`: +Finally, you need to add an entry to `services.yaml`: ``` yaml services: diff --git a/docs/cookbook/setting_up_multi_language_siteaccesses.md b/docs/cookbook/setting_up_multi_language_siteaccesses.md index 6b91521981..69284c6d5d 100644 --- a/docs/cookbook/setting_up_multi_language_siteaccesses.md +++ b/docs/cookbook/setting_up_multi_language_siteaccesses.md @@ -5,7 +5,7 @@ Combining translated content with multiple SiteAccesses successfully can be chal To achieve this for the most typical setups you need to follow three steps: 1. [Create your translations](#create-a-new-translation) in the database via eZ Platform back office. -1. [Create at least two SiteAccesses](#create-new-siteaccesses) in `ezplatform.yml` to deliver the right translated content at the right time. +1. [Create at least two SiteAccesses](#create-new-siteaccesses) in `ezplatform.yaml` to deliver the right translated content at the right time. 1. [Set the correct permissions](#set-permissions-for-the-new-siteaccesses) for the anonymous user to read each SiteAccess. Without these three steps, your SiteAccess configuration will either not work or you will be left with duplicate content from an SEO perspective. @@ -34,7 +34,7 @@ and use the first segment of the URI to match to another. For example: - `www.mysite.com` to match to English - `www.mysite.com/fr` to match to French -To achieve this you need to create at least two new SiteAccesses in your `ezplatform.yml` file. +To achieve this you need to create at least two new SiteAccesses in your `ezplatform.yaml` file. The first bit of this working example lists the new SiteAccesses `en` and `fr` and adds them both to a common group `site_group` (this group will be used for shared settings such as API keys, cache locations, etc.). @@ -76,9 +76,9 @@ siteaccess: !!! note For dynamic URLs you can replace `www.mysite.com` with `%site_domain%` - and then enter `site_domain` as a new entry in `services.yml` at the same level as the database settings. + and then enter `site_domain` as a new entry in `services.yaml` at the same level as the database settings. -Further down in `ezplatform.yml` is the `system` section which comes with the default group named `site_group` (the same group that you modified earlier). +Further down in `ezplatform.yaml` is the `system` section which comes with the default group named `site_group` (the same group that you modified earlier). Add the new `translation_siteaccesses` here. After the `site_group` you register the SiteAccess languages: ``` yaml @@ -97,7 +97,7 @@ Add the new `translation_siteaccesses` here. After the `site_group` you register # templates common to both the en and fr SiteAccess ``` -`ezplatform.yml` with SiteAccesses should now be configured. Clear to cache to complete the job: +`ezplatform.yaml` with SiteAccesses should now be configured. Clear to cache to complete the job: ``` bash php bin/console cache:clear @@ -121,7 +121,7 @@ you can remove the `site` SiteAccess as it is no longer required. It was not possible to remove `site` before, as you first needed to give the appropriate permissions to the new SiteAccesses (`en` and `fr`), without which your site would not have loaded correctly. -In `ezplatform.yml` set the `default_siteaccess` to `en`, +In `ezplatform.yaml` set the `default_siteaccess` to `en`, this will act as the [fallback](../guide/siteaccess/#multilanguage-sites) should none of the matches have been hit. Last but not least, remove `site` from the `list` and `groups` section: diff --git a/docs/guide/bundles.md b/docs/guide/bundles.md index 6ac95317bd..7adb587af0 100644 --- a/docs/guide/bundles.md +++ b/docs/guide/bundles.md @@ -198,7 +198,7 @@ You can see an example of organizing a simple project in the [companion reposito ### Versioning a project -The recommended method is to version the whole ezplatform repository. Per installation configuration should use `parameters.yml`. +The recommended method is to version the whole ezplatform repository. Per installation configuration should use `parameters.yaml`. ## Built-in bundles diff --git a/docs/guide/config_back_office.md b/docs/guide/config_back_office.md index 42e6387ca2..1dd9b88c77 100644 --- a/docs/guide/config_back_office.md +++ b/docs/guide/config_back_office.md @@ -14,7 +14,7 @@ You can copy subtree from CLI using the command: `bin/console ezplatform:copy-su ## Pagination limits Default pagination limits for different sections of the Back Office can be defined through respective settings in -[`ezplatform_default_settings.yml`](https://github.com/ezsystems/ezplatform-admin-ui/blob/master/src/bundle/Resources/config/ezplatform_default_settings.yml#L7) +[`ezplatform_default_settings.yaml`](https://github.com/ezsystems/ezplatform-admin-ui/blob/master/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7) ## Default Locations diff --git a/docs/guide/config_dynamic.md b/docs/guide/config_dynamic.md index aef19b2779..4bb4895f4b 100644 --- a/docs/guide/config_dynamic.md +++ b/docs/guide/config_dynamic.md @@ -112,7 +112,7 @@ This service has `ezpublish.config.dynamic_setting.parser` for ID and implements ### Limitations -- It is not possible to use dynamic settings in your semantic configuration (e.g. `config.yml` or `ezplatform.yml`) as they are meant primarily for parameter injection in services. +- It is not possible to use dynamic settings in your semantic configuration (e.g. `config.yaml` or `ezplatform.yaml`) as they are meant primarily for parameter injection in services. - It is not possible to define an array of options having dynamic settings. They will not be parsed. Workaround is to use separate arguments/setters. - Injecting dynamic settings in request listeners is **not recommended**, as it won't be resolved with the correct scope (request listeners are instantiated before SiteAccess match). diff --git a/docs/guide/config_repository.md b/docs/guide/config_repository.md index f732768366..62daf57017 100644 --- a/docs/guide/config_repository.md +++ b/docs/guide/config_repository.md @@ -91,7 +91,7 @@ repositories: These identifiers can be given human-readable values and can be translated. Those values are used when editing Content Types. The translation domain is `ezplatform_fields_groups`. -This example in `translations/ezplatform_fields_groups.en.yml` defines English names for Field groups: +This example in `translations/ezplatform_fields_groups.en.yaml` defines English names for Field groups: ``` yaml content: Content @@ -102,7 +102,7 @@ user_data: User data ## Limit of archived Content item versions `default_version_archive_limit` controls the number of archived versions per Content item that are stored in the Repository. -By default it is set to 5. This setting is configured in the following way (typically in `ezplatform.yml`): +By default it is set to 5. This setting is configured in the following way (typically in `ezplatform.yaml`): ``` yaml ezpublish: @@ -139,7 +139,7 @@ For example, the following command removes archived versions as user `admin`, bu ## User identifiers -`ezplatform_default_settings.yml` contains two settings that indicate which Content Types are treated like users and user groups: +`ezplatform_default_settings.yaml` contains two settings that indicate which Content Types are treated like users and user groups: ``` yaml ezpublish: diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 622048ae48..59d6d1bc45 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -14,11 +14,11 @@ REVIEW Main configuration files are located in the `app/config` folder. -- `parameters.yml` contains infrastructure-related configuration. It is created based on the default settings defined in `parameters.yml.dist`. -- `config.yml` contains configuration stemming from Symfony and covers settings such as search engine or cache configuration. -- `ezplatform.yml` contains general configuration that is specific for eZ Platform, like for example SiteAccess settings. -- `security.yml` is the place for security-related settings. -- `routing.yml` defines routes that will be used throughout the application. +- `parameters.yaml` contains infrastructure-related configuration. It is created based on the default settings defined in `parameters.yaml.dist`. +- `config.yaml` contains configuration stemming from Symfony and covers settings such as search engine or cache configuration. +- `ezplatform.yaml` contains general configuration that is specific for eZ Platform, like for example SiteAccess settings. +- `security.yaml` is the place for security-related settings. +- `routing.yaml` defines routes that will be used throughout the application. Configuration can be made environment-specific using separate files for each environment. These files contain additional settings and point to the general (not environment-specific) configuration that is applied in other cases. diff --git a/docs/guide/content_rendering.md b/docs/guide/content_rendering.md index 7aeedd2541..6a38f2031d 100644 --- a/docs/guide/content_rendering.md +++ b/docs/guide/content_rendering.md @@ -175,7 +175,7 @@ parameters: ##### Customizing the default controller -The controller used to render content by default can also be changed. The `ezsettings.default.content_view_defaults` container parameter contains a hash that defines how content is rendered by default. It contains a set of [content view rules for the common view types](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/default_settings.yml#L37-L65). This hash can be redefined to whatever suits your requirements, including custom controllers, or even matchers. +The controller used to render content by default can also be changed. The `ezsettings.default.content_view_defaults` container parameter contains a hash that defines how content is rendered by default. It contains a set of [content view rules for the common view types](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/default_settings.yaml#L37-L65). This hash can be redefined to whatever suits your requirements, including custom controllers, or even matchers. ### View providers diff --git a/docs/guide/custom_policies.md b/docs/guide/custom_policies.md index 2884616d2c..941b8dde0c 100644 --- a/docs/guide/custom_policies.md +++ b/docs/guide/custom_policies.md @@ -71,7 +71,7 @@ class MyPolicyProvider extends YamlPolicyProvider protected function getFiles() { return [ - __DIR__ . '/../Resources/config/policies.yml', + __DIR__ . '/../Resources/config/policies.yaml', ]; } } diff --git a/docs/guide/devops.md b/docs/guide/devops.md index 80e9bc8dea..8f7986de93 100644 --- a/docs/guide/devops.md +++ b/docs/guide/devops.md @@ -56,7 +56,7 @@ include Symfony cache use, and a [persistence cache](persistence_cache.md#persis For long-running scripts, see [Executing long-running console commands](performance.md#executing-long-running-console-commands). -If you are running out of memory and don't need to keep track of cache hits and misses, you can disable persistence cache logging, represented by the setting `parameters.ezpublish.spi.persistence.cache.persistenceLogger.enableCallLogging`. In `config_dev.yml`: +If you are running out of memory and don't need to keep track of cache hits and misses, you can disable persistence cache logging, represented by the setting `parameters.ezpublish.spi.persistence.cache.persistenceLogger.enableCallLogging`. In `config_dev.yaml`: ``` yaml parameters: diff --git a/docs/guide/environments.md b/docs/guide/environments.md index 5677465181..309c186677 100644 --- a/docs/guide/environments.md +++ b/docs/guide/environments.md @@ -22,16 +22,16 @@ SetEnvIf Request_URI ".*" SYMFONY_ENV="dev" If you want to use a custom environment (something other than `prod` and `dev`), you need to create the dedicated configuration files for your environment: -- `config/config_.yml` -- `config/ezplatform_.yml` +- `config/config_.yaml` +- `config/ezplatform_.yaml` The name used as `` is the one that can be used as value of the `ENVIRONMENT` variable. -Those files must import the main configuration file, just like the default [`config_dev.yml`](https://github.com/ezsystems/ezpublish-community/blob/master/ezpublish/config/config_dev.yml) does: +Those files must import the main configuration file, just like the default [`config_dev.yaml`](https://github.com/ezsystems/ezpublish-community/blob/master/ezpublish/config/config_dev.yaml) does: ``` yaml imports: - - { resource: config.yml } + - { resource: config.yaml } ``` This enables you to override settings defined in the main configuration file, depending on your environment (for example database settings). diff --git a/docs/guide/extending_modules.md b/docs/guide/extending_modules.md index 999e0ce820..768cffa4ab 100644 --- a/docs/guide/extending_modules.md +++ b/docs/guide/extending_modules.md @@ -131,7 +131,7 @@ The following props are deprecated: ### Configuration -You can configure Universal Discovery module in [universal_discovery_widget.yml file.](https://github.com/ezsystems/ezplatform-admin-ui/blob/master/src/bundle/Resources/config/universal_discovery_widget.yml) +You can configure Universal Discovery module in [universal_discovery_widget.yaml file.](https://github.com/ezsystems/ezplatform-admin-ui/blob/master/src/bundle/Resources/config/universal_discovery_widget.yaml) There you can set e.g. visible tabs, allowed Content Types, search limits etc. ```yaml diff --git a/docs/guide/extending_online_editor.md b/docs/guide/extending_online_editor.md index 2570d11e3c..f7e935c8fa 100644 --- a/docs/guide/extending_online_editor.md +++ b/docs/guide/extending_online_editor.md @@ -19,7 +19,7 @@ If you want to learn how to apply them to your installation follow [Creating a c **Example: YouTube tag** -Preparation of the tag always starts with the configuration file that should be added to the `config` folder. This is sample configuration for the YouTube tag, `custom_tags.yml`: +Preparation of the tag always starts with the configuration file that should be added to the `config` folder. This is sample configuration for the YouTube tag, `custom_tags.yaml`: ```yaml ezpublish: @@ -106,7 +106,7 @@ FactBox tag is a good example for showcasing possibilities of `ezcontent` proper Each custom tag has an `ezcontent` property that contains the tag's main content. This property is editable by a tab in a custom tag. -Create the `custom_tags.yml` configuration file that will be added to the `config` folder. This is sample configuration for FactBox tag: +Create the `custom_tags.yaml` configuration file that will be added to the `config` folder. This is sample configuration for FactBox tag: ```yaml hl_lines="10" ezpublish: diff --git a/docs/guide/extending_page.md b/docs/guide/extending_page.md index a262a577ee..5ed79adbcf 100644 --- a/docs/guide/extending_page.md +++ b/docs/guide/extending_page.md @@ -157,7 +157,7 @@ {# more templates here #} ``` - Add the template to `Resources/config/ez_field_templates.yml`: + Add the template to `Resources/config/ez_field_templates.yaml`: ``` yaml system: @@ -356,7 +356,7 @@ Some blocks can have slightly more complex configuration. An example is the Collection block, which requires an `options` key. This key defines which Content Types can be added to it. - See [this example from the Studio Demo](https://github.com/ezsystems/ezstudio-demo-bundle/blob/master/Resources/config/default_layouts.yml#L160): + See [this example from the Studio Demo](https://github.com/ezsystems/ezstudio-demo-bundle/blob/master/Resources/config/default_layouts.yaml#L160): ``` yaml blocks: diff --git a/docs/guide/http_cache.md b/docs/guide/http_cache.md index a2fe3ce444..0322db2d7f 100644 --- a/docs/guide/http_cache.md +++ b/docs/guide/http_cache.md @@ -314,11 +314,11 @@ ezpublish: You may specify service ID and token: - - using the `service_id` and `key` settings (sub elements of "fastly") in `app/config/ezplatform.yml` - - by setting the parameters `fastly_service_id` and `fastly_key` in `app/config/parameters.yml` + - using the `service_id` and `key` settings (sub elements of "fastly") in `app/config/ezplatform.yaml` + - by setting the parameters `fastly_service_id` and `fastly_key` in `app/config/parameters.yaml` - by setting the environment variables `FASTLY_SERVICE_ID` and `FASTLY_KEY` - Unless you need different settings per SiteAccess it is recommended to either use `app/config/parameters.yml` + Unless you need different settings per SiteAccess it is recommended to either use `app/config/parameters.yaml` or the environment variables. ##### Clear the cache diff --git a/docs/guide/images.md b/docs/guide/images.md index c7cc5b4d58..a6db26c015 100644 --- a/docs/guide/images.md +++ b/docs/guide/images.md @@ -10,7 +10,7 @@ LiipImagineBundle only works on image blobs (no command line tool is needed). Se ## Configuring image variations -Custom image variations are defined in `ezplatform.yml` or any imported semantic configuration file. The definition is [dynamic](configuration.md#dynamic-configuration-with-the-configresolver), so it can be configured per SiteAccess and all the other scopes. +Custom image variations are defined in `ezplatform.yaml` or any imported semantic configuration file. The definition is [dynamic](configuration.md#dynamic-configuration-with-the-configresolver), so it can be configured per SiteAccess and all the other scopes. ``` yaml # Example image variation definition diff --git a/docs/guide/internationalization.md b/docs/guide/internationalization.md index ed9f3b4e38..1a4824f313 100644 --- a/docs/guide/internationalization.md +++ b/docs/guide/internationalization.md @@ -179,17 +179,17 @@ If several translation SiteAccesses share the same language reference, **the fi #### Custom locale configuration -If you need to use a custom locale, you can configure it in `ezplatform.yml`, adding it to the *conversion map*: +If you need to use a custom locale, you can configure it in `ezplatform.yaml`, adding it to the *conversion map*: ``` yaml ezpublish: # Locale conversion map between eZ Publish format (e.g. fre-FR) to POSIX (e.g. fr_FR). - # The key is the eZ Publish locale. Check locale.yml in EzPublishCoreBundle to see natively supported locales. + # The key is the eZ Publish locale. Check locale.yaml in EzPublishCoreBundle to see natively supported locales. locale_conversion: eng-DE: en_DE ``` -A locale *conversion map* example [can be found in the `core` bundle, on `locale.yml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/locale.yml). +A locale *conversion map* example [can be found in the `core` bundle, on `locale.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/locale.yaml). ### More complex translation setup diff --git a/docs/guide/multisite.md b/docs/guide/multisite.md index 4ecfaf46b3..905b482143 100644 --- a/docs/guide/multisite.md +++ b/docs/guide/multisite.md @@ -11,7 +11,7 @@ This feature is a reimplementation of the [PathPrefix](http://doc.ez.no/eZ-Publi ## Configuring multisite -Multisite is configured in `ezplatform.yml`, either at [SiteAccess](siteaccess.md) or SiteAccess group level: +Multisite is configured in `ezplatform.yaml`, either at [SiteAccess](siteaccess.md) or SiteAccess group level: ``` yaml ezpublish: @@ -101,7 +101,7 @@ despite the fact that it is not a sub-item of the "Event" Location. ### Setting the Index Page The Index Page is the page shown when the root index `/` is accessed. -You can configure the Index Page separately for each SiteAccess. Place the parameter `index_page` in your `ezplatform.yml` file, under the correct SiteAccess: +You can configure the Index Page separately for each SiteAccess. Place the parameter `index_page` in your `ezplatform.yaml` file, under the correct SiteAccess: ``` yaml ezpublish: @@ -150,7 +150,7 @@ To do this, organize your templates in the following folder structure: ![Organising templates](img/organising_templates.png "Organising templates") -Now you can use this view configuration (stored e.g. in a `views.yml` file): +Now you can use this view configuration (stored e.g. in a `views.yaml` file): ``` yaml ezpublish: diff --git a/docs/guide/performance.md b/docs/guide/performance.md index de6220d590..760b6a4d7e 100644 --- a/docs/guide/performance.md +++ b/docs/guide/performance.md @@ -98,7 +98,7 @@ To avoid quickly running out of memory while executing such commands you should 1. For logging using monolog, if you use either the default `fingers_crossed`, or `buffer` handler, make sure to specify `buffer_size` to limit how large the buffer grows before it gets flushed: ``` yaml - # config_prod.yml (partial example) + # config_prod.yaml (partial example) monolog: handlers: main: diff --git a/docs/guide/persistence_cache.md b/docs/guide/persistence_cache.md index 7e03e35a7b..f783937976 100644 --- a/docs/guide/persistence_cache.md +++ b/docs/guide/persistence_cache.md @@ -60,7 +60,7 @@ You can select a different cache backend and configure its parameters in the rel #### Multi Repository setup You can [configure multisite to work with multiple repositories](multisite.md#multisite-with-multiple-repositories). -Then, in `ezplatform.yml` you can specify which cache pool you want to use on a SiteAccess or SiteAccess group level. +Then, in `ezplatform.yaml` you can specify which cache pool you want to use on a SiteAccess or SiteAccess group level. The following example shows use in a SiteAccess group: @@ -142,7 +142,7 @@ services: - name: cache.pool clearer: cache.app_clearer provider: 'redis://secret@example.com:1234/13' - # Default CACHE_NAMESPACE value, see app/config/cache_pool/cache.redis.yml for usage with e.g. multi repo. + # Default CACHE_NAMESPACE value, see app/config/cache_pool/cache.redis.yaml for usage with e.g. multi repo. namespace: 'ez' ``` @@ -188,7 +188,7 @@ For best performance we recommend use of Redis Sentinel if it fits your needs. H See [Memcached Cache Adapter in Symfony documentation](https://symfony.com/doc/3.4/components/cache/adapters/memcached_adapter.html#configure-the-connection) for information on how to configure Memcached. -Out of the box in `config/cache_pool/cache.memcached.yml` you'll find a default example that can be used. +Out of the box in `config/cache_pool/cache.memcached.yaml` you'll find a default example that can be used. !!! cloud "eZ Platform Cloud" @@ -205,11 +205,11 @@ services: - name: cache.pool clearer: cache.app_clearer provider: 'memcached://user:pass@localhost?weight=33' - # Default CACHE_NAMESPACE value, see app/config/cache_pool/cache.redis.yml for usage with e.g. multi repo. + # Default CACHE_NAMESPACE value, see app/config/cache_pool/cache.redis.yaml for usage with e.g. multi repo. namespace: 'ez' ``` -See `config/default_parameters.yml` and `config/cache_pool/cache.memcached.yml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. +See `config/default_parameters.yaml` and `config/cache_pool/cache.memcached.yaml` for further details on `CACHE_POOL`, `CACHE_DSN` and `CACHE_NAMESPACE`. !!! caution "Clearing Memcached cache" diff --git a/docs/guide/personalization.md b/docs/guide/personalization.md index ed3900f012..15269da7c1 100644 --- a/docs/guide/personalization.md +++ b/docs/guide/personalization.md @@ -36,17 +36,17 @@ $bundles = [ ### 3. Import additional routing -Import additional routing by adding the following lines to your `routing.yml` file: +Import additional routing by adding the following lines to your `routing.yaml` file: ``` yaml recommendationBundleRestRoutes: - resource: '@EzSystemsRecommendationBundle/Resources/config/routing_rest.yml' + resource: '@EzSystemsRecommendationBundle/Resources/config/routing_rest.yaml' prefix: '%ezpublish_rest.path_prefix%' ``` !!! note "Legacy support" - Legacy support is disabled by default. To enable the legacy search engine (requires `ezpublish-kernel` bundle) copy these service definitions to your `app/config/services.yml` file and uncomment them: + Legacy support is disabled by default. To enable the legacy search engine (requires `ezpublish-kernel` bundle) copy these service definitions to your `app/config/services.yaml` file and uncomment them: ``` yaml # ez_recommendation.legacy.search_engine: @@ -89,7 +89,7 @@ Allow public HTTP(S) access to the recommendation bundle API (` If the company policy is to use BASIC AUTH on the API interfaces, you need to add some specific configuration. -You probably have some access restrictions on your site defined in app/config/security.yml +You probably have some access restrictions on your site defined in app/config/security.yaml ``` yaml security: @@ -105,7 +105,7 @@ security: ``` Create a user with the name of the CustomerID and a password which is the license key in your local security provider. This user must have access granted on the URLs provided by the bundle API (see above). -In order to tell the recommender to use this user and password to request resources on the eZ Platform instance, you can configure this as follows (an example file is available in the bundle under `Resources/config/default_settings.yml`): +In order to tell the recommender to use this user and password to request resources on the eZ Platform instance, you can configure this as follows (an example file is available in the bundle under `Resources/config/default_settings.yaml`): ``` yaml # Export folder authentication method: @@ -127,9 +127,9 @@ Place this in a settings file which won't be affected by an update to the Recomm Visitor events (clicks, buys, ...) on the site need to be sent to the Personalization Solution for the recommendations to be calculated. The content types that are marked to be tracked are also exported to the Personalization Engine. Please note that you can only recommend what you track! -By defining the Content Types in the local `app/config/config.yml` file, the content will be initially exported by a script. After this, it will be kept in sync with the Personalization Solution everytime a change occurs in the eZ Platform back office. +By defining the Content Types in the local `app/config/config.yaml` file, the content will be initially exported by a script. After this, it will be kept in sync with the Personalization Solution everytime a change occurs in the eZ Platform back office. -The bundle's configuration is SiteAccess-aware. This is an example of the settings (in `config.yml`): +The bundle's configuration is SiteAccess-aware. This is an example of the settings (in `config.yaml`): ``` yaml ez_recommendation: @@ -154,7 +154,7 @@ The following parameters need to be included in the settings file: #### Advanced configuration -If the content's author or image are stored in a different Field, you can specify its name in the `parameters.yml` file: +If the content's author or image are stored in a different Field, you can specify its name in the `parameters.yaml` file: ``` yaml ez_recommendation.field_identifiers: @@ -167,7 +167,7 @@ ez_recommendation.field_identifiers: blog_post: main_image ``` -In case a content owner ID is missing, you can set up the default content author in the `default_settings.yml` file: +In case a content owner ID is missing, you can set up the default content author in the `default_settings.yaml` file: ``` yaml ez_recommendation.default.author_id: 14 # ID: 14 is default ID of admin user @@ -581,7 +581,7 @@ Take a look at the scenario configuration in the [Admin Dashboard](https://admin ### Logging -Most operations are logged via the `ez_recommendation` [Monolog channel](http://symfony.com/doc/current/cookbook/logging/channels_handlers.html). To log everything about Recommendation to `dev.recommendation.log`, add the following to your `config.yml`: +Most operations are logged via the `ez_recommendation` [Monolog channel](http://symfony.com/doc/current/cookbook/logging/channels_handlers.html). To log everything about Recommendation to `dev.recommendation.log`, add the following to your `config.yaml`: ``` yaml monolog: diff --git a/docs/guide/richtext_block.md b/docs/guide/richtext_block.md index 8d5e963be9..6a1ff50648 100644 --- a/docs/guide/richtext_block.md +++ b/docs/guide/richtext_block.md @@ -32,7 +32,7 @@ ``` yaml imports: - - resource: { layouts.yml } + - resource: { layouts.yaml } ``` Next, create a subscriber that converts a string of data into XML. @@ -95,7 +95,7 @@ ``` - Note that in the line 32, `my_block` is the name of the block defined in the `layouts.yml` file (line 3). + Note that in the line 32, `my_block` is the name of the block defined in the `layouts.yaml` file (line 3). This line also implements the `PreRender` method. Lines 41-51 handle the conversion of content into XML string. diff --git a/docs/guide/security.md b/docs/guide/security.md index 849d7d3253..bcb87e5fce 100644 --- a/docs/guide/security.md +++ b/docs/guide/security.md @@ -34,7 +34,7 @@ logout: !!! note You can fully customize the routes and/or the controller used for login. - However, remember to match `login_path`, `check_path` and `logout.path` from `security.yml`. + However, remember to match `login_path`, `check_path` and `logout.path` from `security.yaml`. See [security configuration reference](http://symfony.com/doc/3.4/reference/configuration/security.html) and [standard login form documentation](http://symfony.com/doc/3.4/security/form_login_setup.html). @@ -63,7 +63,7 @@ ezpublish: ##### Redirection after login -By default, Symfony redirects to the [URI configured in `security.yml` as `default_target_path`](http://symfony.com/doc/3.4/reference/configuration/security.html). If not set, it defaults to `/`. +By default, Symfony redirects to the [URI configured in `security.yaml` as `default_target_path`](http://symfony.com/doc/3.4/reference/configuration/security.html). If not set, it defaults to `/`. #### Remember me diff --git a/docs/guide/sessions.md b/docs/guide/sessions.md index 0cd5c4c001..dfe0f24119 100644 --- a/docs/guide/sessions.md +++ b/docs/guide/sessions.md @@ -114,7 +114,7 @@ Alternatively if you have needs to configure Redis servers dynamically: !!! note - For eZ Platform Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yml` config. + For eZ Platform Cloud (and Platform.sh), this is already configured in `config/env/platformsh.php` based on `.platform.yaml` config. If you are on `php-redis` v4.2.0 and higher, you can optionally tweak [`php-redis` settings](https://github.com/phpredis/phpredis#session-locking) for session locking. diff --git a/docs/guide/signalslots.md b/docs/guide/signalslots.md index fb485673c1..c53ba46f71 100644 --- a/docs/guide/signalslots.md +++ b/docs/guide/signalslots.md @@ -167,7 +167,7 @@ class OnPublishSlot extends BaseSlot You now need to register `OnPublishSlot` as a service in the ServiceContainer and identify it as a valid Slot. -In `services.yml` (in your bundle): +In `services.yaml` (in your bundle): ``` yaml services: @@ -207,7 +207,7 @@ All you need to do is to implement an event listener or subscriber and register This very simple example will just log the received signal. -In `services.yml`: +In `services.yaml`: ``` yaml services: diff --git a/docs/guide/siteaccess.md b/docs/guide/siteaccess.md index 4b5b5a04d7..a4d9719e1e 100644 --- a/docs/guide/siteaccess.md +++ b/docs/guide/siteaccess.md @@ -36,7 +36,7 @@ you need to create your own admin SiteAccesses and add them to this group. In ca ## Configuring SiteAccesses -You configure SiteAccess in your config files (e.g. `ezplatform.yml`) under the `ezpublish.siteacess` keys. +You configure SiteAccess in your config files (e.g. `ezplatform.yaml`) under the `ezpublish.siteacess` keys. The required elements of the configuration are: #### `list` diff --git a/docs/guide/solr.md b/docs/guide/solr.md index 9cd2a705ea..e3be6123c5 100644 --- a/docs/guide/solr.md +++ b/docs/guide/solr.md @@ -266,7 +266,7 @@ If you have not configured your setup correctly, some exceptions might happen on Here are the most common issues you may encounter: - Exception if Binary files in database have an invalid path prefix - - Make sure `var_dir` is configured properly in `ezplatform.yml` configuration. + - Make sure `var_dir` is configured properly in `ezplatform.yaml` configuration. - If your database is inconsistent in regards to file paths, try to update entries to be correct *(make sure to make a backup first)*. - Exception on unsupported Field Types - Make sure to implement all Field Types in your installation, or to configure missing ones as [NullType](../api/field_type_reference.md#null-field-type) if implementation is not needed. @@ -447,7 +447,7 @@ To avoid duplication, full-text data is indexed on the Content document only. Kn Indexing additional data is done by implementing a document field mapper and registering it at one of the five extension points described above. You can create the field mapper class anywhere inside your bundle, -as long as when you register it as a service, the `class` parameter in your `services.yml` matches the correct path. +as long as when you register it as a service, the `class` parameter in your `services.yaml` matches the correct path. There are three different field mappers. Each mapper implements two methods, by the same name, but accepting different arguments: - `ContentFieldMapper` diff --git a/docs/guide/templates.md b/docs/guide/templates.md index ab312199b0..381d15ed6c 100644 --- a/docs/guide/templates.md +++ b/docs/guide/templates.md @@ -13,16 +13,16 @@ Each template must be mentioned in a configuration file together with a definiti !!! note - If you decide to create a new configuration file, you will need to import it by including an import statement in `ezplatform.yml`. Add the following code at the beginning of `ezplatform.yml`: + If you decide to create a new configuration file, you will need to import it by including an import statement in `ezplatform.yaml`. Add the following code at the beginning of `ezplatform.yaml`: ``` yaml imports: - - { resource: .yml } + - { resource: .yaml } ``` !!! tip - If you are using the recommended .yml files for configuration, here are the basic rules for this format: + If you are using the recommended .yaml files for configuration, here are the basic rules for this format: The configuration is based on pairs of a key and its value, separated by a colon, presented in the following form: key: value. The value of the key may contain further keys, with their values containing further keys, and so on. This hierarchy is marked using indentation – each level lower in the hierarchy must be indented in comparison with its parent. @@ -88,7 +88,7 @@ Templates in eZ Platform are written in the Twig templating language. Most of a Twig template file can look like an ordinary HTML file. This is also where you can define places where Content items or their fields will be embedded. -The configuration described above lets you select one template to be used in a given situation, but this does not mean you are limited to only one file per case. It is possible to include other templates in the main template file. For example, you can have a single template for the footer of a page and include it in many other templates. Such templates do not need to be mentioned in the configuration .yml file. +The configuration described above lets you select one template to be used in a given situation, but this does not mean you are limited to only one file per case. It is possible to include other templates in the main template file. For example, you can have a single template for the footer of a page and include it in many other templates. Such templates do not need to be mentioned in the configuration .yaml file. !!! tip diff --git a/docs/migrating/migrating_from_ez_publish_platform.md b/docs/migrating/migrating_from_ez_publish_platform.md index b69ec9090a..832ecfa62d 100644 --- a/docs/migrating/migrating_from_ez_publish_platform.md +++ b/docs/migrating/migrating_from_ez_publish_platform.md @@ -82,11 +82,11 @@ While no longer bundled, the XmlText Field Type still exists and is needed to p To move over your own custom configurations, follow the conventions below and manually move the settings over: -- `/ezpublish/config/parameters.yml => /app/config/parameters.yml` +- `/ezpublish/config/parameters.yaml => /app/config/parameters.yaml` - *For parameters like before, for new parameters you'll be prompted on later step.* -- `/ezpublish/config/config.yml => /app/config/config.yml` +- `/ezpublish/config/config.yaml => /app/config/config.yaml` - *For system/framework config, and for defining global db, cache, search settings.* -- `/ezpublish/config/ezpublish.yml => /app/config/ezplatform.yml` +- `/ezpublish/config/ezpublish.yaml => /app/config/ezplatform.yaml` - *For SiteAccess, site groups and repository settings.* !!! note "Changes to repository configuration" @@ -94,14 +94,14 @@ To move over your own custom configurations, follow the conventions below and ma When moving configuration over, be aware that as of 5.4.5 and higher, repository configuration has been enhanced to allow configuring storage engine and search engine independently. ``` yaml - # Default ezplatform.yml repositories configuration with comments + # Default ezplatform.yaml repositories configuration with comments ezpublish: # Repositories configuration, set up default repository to support solr if enabled repositories: default: # For storage engine use kernel default (current LegacyStorageEngine) storage: ~ - # For search engine, pick the one configured in parameters.yml, either "legacy" or "solr" + # For search engine, pick the one configured in parameters.yaml, either "legacy" or "solr" search: engine: '%search_engine%' connection: default @@ -109,7 +109,7 @@ To move over your own custom configurations, follow the conventions below and ma !!! note "Make sure to adapt SiteAccess names" - In the default configurations in **ezplatform.yml** you'll find existing SiteAccesses like `site`, and depending on installation perhaps a few others, all under a site group called `site\_group`. Make sure to change those to what you had in **ezpublish.yml** to avoid issues with having to log in to your website, given user/login policy rules will need to be updated if you change names of SiteAccess as part of the upgrade. + In the default configurations in **ezplatform.yaml** you'll find existing SiteAccesses like `site`, and depending on installation perhaps a few others, all under a site group called `site\_group`. Make sure to change those to what you had in **ezpublish.yaml** to avoid issues with having to log in to your website, given user/login policy rules will need to be updated if you change names of SiteAccess as part of the upgrade. ##### 2.4. Bundles @@ -171,7 +171,7 @@ When that is done, execute the following to update and install all packages from !!! note - At the end of the process, you will be asked for values for parameters.yml not already moved from old installation, or new *(as defined in parameters.yml.dist)*. + At the end of the process, you will be asked for values for parameters.yaml not already moved from old installation, or new *(as defined in parameters.yaml.dist)*. ##### 2.8 Register EzSystemsEzPlatformXmlTextFieldTypeBundle @@ -405,7 +405,7 @@ It is possible that after the upgrade your admin screen will be unstyled. This m If your legacy site uses old-style URL aliases, to upgrade them successfully you need to apply a workaround to the slug converter. Where the slug converter service is defined, set second config parameter to use `urlalias_compat` by adding a new argument to the existing settings: ``` yaml -# in vendor/ezsystems/ezpublish-kernel/eZ/Publish/Core/settings/storage\_engines/common.yml +# in vendor/ezsystems/ezpublish-kernel/eZ/Publish/Core/settings/storage\_engines/common.yaml ezpublish.persistence.slug_converter: class: '%ezpublish.persistence.slug_converter.class%' arguments: diff --git a/docs/releases/earlier_releases.md b/docs/releases/earlier_releases.md index 199d9c52e2..7dd61fa9f5 100644 --- a/docs/releases/earlier_releases.md +++ b/docs/releases/earlier_releases.md @@ -18,7 +18,7 @@ The `ezsystems/ezplatform` package has been completely cleaned from any referen - A clean AppBundle is now shipped and enabled by default. Unless you have a specific reason not to do so, this is where your projects should start from - The `ezpublish` folder now contains an empty `Resources/views` directory. This is where the templates used in the app should go. They can be referenced from templates or yaml files as `"path/to/file"`, relative to the `views` directory -- Settings have been cleaned up: `ezpublish.yml` has been renamed to `ezplatform.yml`, and greatly simplified. It is now imported from `config.yml` instead of being force-loaded by the kernel +- Settings have been cleaned up: `ezpublish.yaml` has been renamed to `ezplatform.yaml`, and greatly simplified. It is now imported from `config.yaml` instead of being force-loaded by the kernel This change should make it much easier to get started on a project. It also enforces a better separation, on our side, of demo related and application related changes. @@ -347,7 +347,7 @@ Image variations generated by Imagine can now be purged using the application co php ezpublish/console liip:imagine:cache:remove --filters=large --filters=gallery -v ``` -Note that this change comes with a modification of the variations storage path. This change will be transparent from a user's perspective, but you may want to purge the existing variations. To do this, you need to [switch to the legacy handler](https://github.com/ezsystems/ezpublish-kernel/blob/cc3f25fa25393e404f5af2806176fa07835721ef/eZ/Bundle/EzPublishCoreBundle/Resources/config/image.yml#L200) by redeclaring the `ezpublish.image_alias.variation_purger` service to `ezpublish.image_alias.variation_purger.legacy_storage_image_file`. +Note that this change comes with a modification of the variations storage path. This change will be transparent from a user's perspective, but you may want to purge the existing variations. To do this, you need to [switch to the legacy handler](https://github.com/ezsystems/ezpublish-kernel/blob/cc3f25fa25393e404f5af2806176fa07835721ef/eZ/Bundle/EzPublishCoreBundle/Resources/config/image.yaml#L200) by redeclaring the `ezpublish.image_alias.variation_purger` service to `ezpublish.image_alias.variation_purger.legacy_storage_image_file`. More info: [Technical specifications](https://github.com/ezsystems/ezpublish-kernel/blob/v6.0.0-alpha3/doc/specifications/image/variation_purging.md), [Implementation story](http://jira.ez.no/browse/EZP-23367). diff --git a/docs/releases/ez_platform_16.02_release_notes.md b/docs/releases/ez_platform_16.02_release_notes.md index 641845492a..ac0112abfc 100644 --- a/docs/releases/ez_platform_16.02_release_notes.md +++ b/docs/releases/ez_platform_16.02_release_notes.md @@ -217,6 +217,6 @@ git merge upgrade-1.2.0 Double check the following before you test: -You should now have a new route in` app/config/routing.yml`: +You should now have a new route in` app/config/routing.yaml`: -`_ezplatformRepositoryFormsRoutes: resource: "@EzSystemsRepositoryFormsBundle/Resources/config/routing.yml"` +`_ezplatformRepositoryFormsRoutes: resource: "@EzSystemsRepositoryFormsBundle/Resources/config/routing.yaml"` diff --git a/docs/releases/ez_platform_v1.5.0_release_notes.md b/docs/releases/ez_platform_v1.5.0_release_notes.md index 4656a83c35..3ef4dbeb6e 100644 --- a/docs/releases/ez_platform_v1.5.0_release_notes.md +++ b/docs/releases/ez_platform_v1.5.0_release_notes.md @@ -83,7 +83,7 @@ This release has received lots of fixes to remove deprecation warnings when runn - *Contribution by Inviqa to improve performance when running eZ Platform on S3* - ##### Developer Experience: - - Docker: Added Redis support and some more inline documentation ([see `doc/` folder](https://github.com/ezsystems/ezplatform/blob/ff191377fc68c53478c68da892f9eb79dce6347e/doc/docker-compose/redis.yml)) + - Docker: Added Redis support and some more inline documentation ([see `doc/` folder](https://github.com/ezsystems/ezplatform/blob/ff191377fc68c53478c68da892f9eb79dce6347e/doc/docker-compose/redis.yaml)) ## Full list of changes diff --git a/docs/releases/ez_platform_v2.2.0.md b/docs/releases/ez_platform_v2.2.0.md index 5ba5cd3295..88b7f98e10 100644 --- a/docs/releases/ez_platform_v2.2.0.md +++ b/docs/releases/ez_platform_v2.2.0.md @@ -21,7 +21,7 @@ This version introduces the **Page Builder** which replaces the Landing Page edi They will be included again in a future release. The Places Page Builder block has been removed from the clean installation and will only be available in the demo out of the box. - If you had been using this block in your site, re-apply its configuration based on [the demo](https://github.com/ezsystems/ezplatform-ee-demo/blob/master/app/config/blocks.yml). + If you had been using this block in your site, re-apply its configuration based on [the demo](https://github.com/ezsystems/ezplatform-ee-demo/blob/master/app/config/blocks.yaml). #### Modifying the Page Content Type diff --git a/docs/releases/ez_platform_v2.4.md b/docs/releases/ez_platform_v2.4.md index 6f303512ae..432039a469 100644 --- a/docs/releases/ez_platform_v2.4.md +++ b/docs/releases/ez_platform_v2.4.md @@ -190,7 +190,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa } ``` - 2\. Add the following configuration to `/app/config/config.yml` + 2\. Add the following configuration to `/app/config/config.yaml` ``` yaml lexik_jwt_authentication: @@ -209,7 +209,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa By default `HS256` is used as signature algorithm for generated token but we strongly recommend switching to SSH keys. For more information see [`LexikJWTAuthenticationBundle` installation instruction.](https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#installation) - 3\. Add `EzSystems\EzPlatformPageBuilder\Security\EditorialMode\TokenAuthenticator` authentication provider to `ezpublish_front` firewall before `form_login` in `app/config/security.yml`: + 3\. Add `EzSystems\EzPlatformPageBuilder\Security\EditorialMode\TokenAuthenticator` authentication provider to `ezpublish_front` firewall before `form_login` in `app/config/security.yaml`: ``` yaml security: @@ -224,7 +224,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa # ... ``` - 4\. Make sure that parameter `page_builder.token_authenticator.enabled` has value `true`. If the parameter is not present, add it to `/app/config/config.yml`: + 4\. Make sure that parameter `page_builder.token_authenticator.enabled` has value `true`. If the parameter is not present, add it to `/app/config/config.yaml`: ``` yaml # ... diff --git a/docs/releases/ez_studio_16.02_release_notes.md b/docs/releases/ez_studio_16.02_release_notes.md index d75202856f..bcb553c14e 100644 --- a/docs/releases/ez_studio_16.02_release_notes.md +++ b/docs/releases/ez_studio_16.02_release_notes.md @@ -163,7 +163,7 @@ Caution! If you had custom siteaccesses or languages set up in your installation, a conflict may appear here. This is because new siteaccesses are introduced in Studio demo in this release: "fr" for French, "de" for German and "no" for Norwegian. -To avoid overriding your siteaccesses with the new ones, you need to accept your own changes in the `app/config/ezplatform.yml` file. +To avoid overriding your siteaccesses with the new ones, you need to accept your own changes in the `app/config/ezplatform.yaml` file. If you have no custom siteaccesses or languages and no conflict occurs, you can do one of the following things: @@ -277,6 +277,6 @@ git merge upgrade-1.2.0 Double check the following before you test: -You should now have a new route in` app/config/routing.yml`: +You should now have a new route in` app/config/routing.yaml`: -`_ezplatformRepositoryFormsRoutes: resource: "@EzSystemsRepositoryFormsBundle/Resources/config/routing.yml"` +`_ezplatformRepositoryFormsRoutes: resource: "@EzSystemsRepositoryFormsBundle/Resources/config/routing.yaml"` diff --git a/docs/releases/updating_ez_platform.md b/docs/releases/updating_ez_platform.md index 9db9338567..91874ae25f 100644 --- a/docs/releases/updating_ez_platform.md +++ b/docs/releases/updating_ez_platform.md @@ -261,7 +261,7 @@ Some versions require updates to the database. Look through [the list of databas Since v1.8 you can add a File field to the Form block on a Landing Page. Files uploaded through such a form will be automatically placed in a specific folder in the repository. - If you are upgrading to v1.8 you need to create this folder and assign it to a new specific Section. Then, add them in the config (for example, in `app/config/default_parameters.yml`, depending on how your configuration is set up): + If you are upgrading to v1.8 you need to create this folder and assign it to a new specific Section. Then, add them in the config (for example, in `app/config/default_parameters.yaml`, depending on how your configuration is set up): ``` bash #Location id of the root for form uploads @@ -337,7 +337,7 @@ Some versions require updates to the database. Look through [the list of databas You should also change the character set that is specified in the application config: - In `app/config/config.yml`, set the following: + In `app/config/config.yaml`, set the following: ``` yml doctrine: @@ -346,7 +346,7 @@ Some versions require updates to the database. Look through [the list of databas default: charset: utf8mb4 ``` - Also make the corresponding change in `app/config/dfs/dfs.yml`. + Also make the corresponding change in `app/config/dfs/dfs.yaml`. ##### Page builder @@ -528,7 +528,7 @@ Some versions require updates to the database. Look through [the list of databas However, if you do not update your meta-repository, you need to take two additional steps: - enable `EzSystems\DoctrineSchemaBundle\DoctrineSchemaBundle()` in `AppKernel.php` - - add [`ez_doctrine_schema`](https://github.com/ezsystems/ezplatform/blob/master/app/config/config.yml#L33) configuration + - add [`ez_doctrine_schema`](https://github.com/ezsystems/ezplatform/blob/master/app/config/config.yaml#L33) configuration #### Changes to Matrix Field Type diff --git a/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md b/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md index 175f7b2b15..bfd0c16708 100644 --- a/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md +++ b/docs/tutorials/enterprise_beginner/1_get_a_starter_website.md @@ -67,14 +67,14 @@ Place the [`pagelayout.html.twig`](https://github.com/ezsystems/ezstudio-beginne Place two configuration files in `app/config` folder: -- [`views.yml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/app/config/views.yml) -- [`image_variations.yml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/app/config/image_variations.yml) +- [`views.yaml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/app/config/views.yaml) +- [`image_variations.yaml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/app/config/image_variations.yaml) -Modify the `config.yml` file located in `app/config` folder and add the following lines at the end of the `imports` block: +Modify the `config.yaml` file located in `app/config` folder and add the following lines at the end of the `imports` block: ``` yaml - - { resource: views.yml } - - { resource: image_variations.yml } + - { resource: views.yaml } + - { resource: image_variations.yaml } ``` In `web/assets` folder create: @@ -89,7 +89,7 @@ Finally, add the following files to `src/AppBundle`, to create dynamic links in - [`Controller/MenuController.php`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/src/AppBundle/Controller/MenuController.php) - [`DependencyInjection/AppExtension.php`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/src/AppBundle/DependencyInjection/AppExtension.php) - [`QueryType/MenuQueryType.php`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/src/AppBundle/QueryType/MenuQueryType.php) -- [`Resources/config/services.yml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/src/AppBundle/Resources/config/services.yml) +- [`Resources/config/services.yaml`](https://github.com/ezsystems/ezstudio-beginner-tutorial/blob/v2-step1/src/AppBundle/Resources/config/services.yaml) All the files you've placed in `src/AppBundle` are not the scope of this tutorial and we won't go here into detail on how they work. diff --git a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md index e5fac43887..d95b3527f4 100644 --- a/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md +++ b/docs/tutorials/enterprise_beginner/2_prepare_the_landing_page.md @@ -42,7 +42,7 @@ Preparing a new layout requires three things: #### Create entry in configuration -First create a new file for layout configuration, `app/config/layouts.yml`: +First create a new file for layout configuration, `app/config/layouts.yaml`: ``` yaml hl_lines="3 5 7 8" ezplatform_page_fieldtype: @@ -61,10 +61,10 @@ ezplatform_page_fieldtype: ``` Creating the file is not enough, you also need to tell the app to read and use it. -Add the following line to `app/config/config.yml`, at the end of the `imports` block: +Add the following line to `app/config/config.yaml`, at the end of the `imports` block: ``` yaml -- { resource: layouts.yml } +- { resource: layouts.yaml } ``` #### Add thumbnail @@ -177,7 +177,7 @@ Add this new template, `app/Resources/views/full/landing_page.html.twig`: This template simply renders the page content. If there is any additional content or formatting you would like to apply to every Page, it should be placed in this template. Now you need to tell the app to use this template to render Pages. -Edit the `app/config/views.yml` file and add the following code under the `full:` key: +Edit the `app/config/views.yaml` file and add the following code under the `full:` key: ``` yaml landing_page: diff --git a/docs/tutorials/enterprise_beginner/3_use_existing_blocks.md b/docs/tutorials/enterprise_beginner/3_use_existing_blocks.md index 0bba2f4732..68f54a76d5 100644 --- a/docs/tutorials/enterprise_beginner/3_use_existing_blocks.md +++ b/docs/tutorials/enterprise_beginner/3_use_existing_blocks.md @@ -38,7 +38,7 @@ First, create an override template for the Content List block: `app/Resources/vi ``` Then add a configuration that will tell the app to use this template instead of the default one. -In `app/config/layouts.yml` add the following code at the end of the file, under the `ezplatform_page_fieldtype` key on the same level as `layouts`: +In `app/config/layouts.yaml` add the following code at the end of the file, under the `ezplatform_page_fieldtype` key on the same level as `layouts`: ``` yaml blocks: @@ -51,7 +51,7 @@ blocks: The template makes use of an [image variation](../../guide/images.md) (line 10). It is the thumbnail of the Dog Breed image that will be displayed in the block. -To configure this variation, open the `app/config/image_variations.yml` file and add the following code under the `image_variations` key: +To configure this variation, open the `app/config/image_variations.yaml` file and add the following code under the `image_variations` key: ``` yaml content_list: @@ -111,7 +111,7 @@ Publish the page now and move on to creating another type of block. The next block is the Content Scheduler block that will air articles at predetermined times. -First, add a configuration that points to the layout. Go to `app/config/layouts.yml` again and add the following code under `blocks` on the same level as the `contentlist` key: +First, add a configuration that points to the layout. Go to `app/config/layouts.yaml` again and add the following code under `blocks` on the same level as the `contentlist` key: ``` yaml schedule: @@ -150,7 +150,7 @@ When you look at the template, you can see three blocks, each of which will rend So far you only have templates for `full` view for Articles. This means you need to create a `featured` view template, otherwise you will get an error when trying to add Content to the block. -You need to modify the `app/config/views.yml` file to indicate when to use the template. +You need to modify the `app/config/views.yaml` file to indicate when to use the template. Add the following code to this file, on the same level as the `full` key: ``` yaml @@ -171,7 +171,7 @@ Now create an `app/Resources/views/featured/article.html.twig` file: ``` Like in the case of the Content List block, the template specifies an image variation. -Add it in `app/config/image_variations.yml` under the `image_variations` key: +Add it in `app/config/image_variations.yaml` under the `image_variations` key: ``` yaml featured_article: diff --git a/docs/tutorials/enterprise_beginner/4_create_a_custom_block.md b/docs/tutorials/enterprise_beginner/4_create_a_custom_block.md index e8d91372a8..05698dad48 100644 --- a/docs/tutorials/enterprise_beginner/4_create_a_custom_block.md +++ b/docs/tutorials/enterprise_beginner/4_create_a_custom_block.md @@ -16,7 +16,7 @@ To create a custom block from scratch you need four elements: ### Block configuration -In `app/config/layouts.yml` add the following block under the `blocks` key: +In `app/config/layouts.yaml` add the following block under the `blocks` key: ``` yaml hl_lines="10" blocks: @@ -183,7 +183,7 @@ private function findContentItems(Location $location): array ### Add the listener to services -Finally, you need to add the listener as a service. Add the following configuration to `app/config/services.yml` under the `services` key: +Finally, you need to add the listener as a service. Add the following configuration to `app/config/services.yaml` under the `services` key: ``` yaml services: diff --git a/docs/tutorials/extending_admin_ui/1_creating_a_bundle.md b/docs/tutorials/extending_admin_ui/1_creating_a_bundle.md index d7959b2416..0c839d910a 100644 --- a/docs/tutorials/extending_admin_ui/1_creating_a_bundle.md +++ b/docs/tutorials/extending_admin_ui/1_creating_a_bundle.md @@ -8,7 +8,7 @@ bin/console generate:bundle --namespace=EzSystems/ExtendingTutorialBundle --dir= ``` This will generate a new bundle skeleton in `src/EzSystems/ExtendingTutorialBundle`, -add it to the application kernel and configure eZ Platform to use the generated `routing.yml`. +add it to the application kernel and configure eZ Platform to use the generated `routing.yaml`. !!! tip "Bundle name" diff --git a/docs/tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md b/docs/tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md index 68dd2de95f..a1848ffaae 100644 --- a/docs/tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md +++ b/docs/tutorials/extending_admin_ui/2_creating_a_dashboard_tab.md @@ -15,7 +15,7 @@ This tab, called "Articles", will list ten most recently modified Content items ## Register a service -First, add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yml`, +First, add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yaml`, which was created when [the bundle was generated](1_creating_a_bundle.md). Place the block indented, under the `services` key: ``` yml diff --git a/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md b/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md index e3a52cd02c..3026320f40 100644 --- a/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md +++ b/docs/tutorials/extending_admin_ui/3_creating_a_content_list.md @@ -11,7 +11,7 @@ You will be able to filter the list by Content Types using a drop-down menu. The first step is to add an event listener. -To register the listener as a service, add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yml`. +To register the listener as a service, add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yaml`. Place the block indented, under the `services` key: ``` yaml @@ -65,7 +65,7 @@ Line 26 points to the new route that you need to add to the routing file. ## Add routing -Add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/routing.yml`: +Add the following block to `src/EzSystems/ExtendingTutorialBundle/Resources/config/routing.yaml`: ``` yaml hl_lines="5" ezsystems_extending_tutorial.all_content_list.list: @@ -79,7 +79,7 @@ ezsystems_extending_tutorial.all_content_list.list: As you can see in the code above, the next step is creating a controller that will take care of the article list view. -First, ensure that the controller is configured in `services.yml`. +First, ensure that the controller is configured in `services.yaml`. Add the following block (indented, under the `services` key) to that file: ``` yaml diff --git a/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md b/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md index 106e49e97c..3aa05d91ba 100644 --- a/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md +++ b/docs/tutorials/extending_admin_ui/4_filtering_the_content_list.md @@ -5,7 +5,7 @@ In this step you will enable the content list to be filtered by Content Types. ## Update routing First, modify the route to the content list page. -In `src/EzSystems/ExtendingTutorialBundle/Resources/config/routing.yml` add the `contentTypeIdentifier` parameter and set its default value: +In `src/EzSystems/ExtendingTutorialBundle/Resources/config/routing.yaml` add the `contentTypeIdentifier` parameter and set its default value: ``` yml hl_lines="2 5" ezsystems_extending_tutorial.all_content_list.list: diff --git a/docs/tutorials/extending_admin_ui/5_creating_a_udw_tab.md b/docs/tutorials/extending_admin_ui/5_creating_a_udw_tab.md index b4e5cc323c..1e695c6168 100644 --- a/docs/tutorials/extending_admin_ui/5_creating_a_udw_tab.md +++ b/docs/tutorials/extending_admin_ui/5_creating_a_udw_tab.md @@ -443,7 +443,7 @@ Place the compiled files in `src/EzSystems/ExtendingTutorialBundle/Resources/pub ## Add configuration Next, ensure that the React modules will be correctly initialized. -To do this, add the following instructions to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yml`. +To do this, add the following instructions to `src/EzSystems/ExtendingTutorialBundle/Resources/config/services.yaml`. This adds JavaScript files into specific zones inside the built-in `layout.html.twig` file. ReactJS modules (the compiled files) should be placed in the `custom-admin-ui-modules` group, @@ -529,7 +529,7 @@ class EzSystemsExtendingTutorialExtension extends Extension $config = $this->processConfiguration($configuration, $configs); $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); - $loader->load('services.yml'); + $loader->load('services.yaml'); } } ``` diff --git a/docs/tutorials/extending_admin_ui/6_adding_a_custom_tag.md b/docs/tutorials/extending_admin_ui/6_adding_a_custom_tag.md index 79298bab7a..fbf373d999 100644 --- a/docs/tutorials/extending_admin_ui/6_adding_a_custom_tag.md +++ b/docs/tutorials/extending_admin_ui/6_adding_a_custom_tag.md @@ -8,7 +8,7 @@ In this step you will add a custom tag which will enable you to embed YouTube vi ## Configure the custom tag First, create a file that will contain the configuration for the custom tags. -Add file `custom_tags.yml` to `src/EzSystems/ExtendingTutorialBundle/Resources/config`: +Add file `custom_tags.yaml` to `src/EzSystems/ExtendingTutorialBundle/Resources/config`: ``` yaml hl_lines="5 10 12" ezpublish: @@ -93,7 +93,7 @@ use Symfony\Component\Yaml\Yaml; public function prepend( ContainerBuilder $container ) { $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config')); - $loader->load('custom_tags.yml'); + $loader->load('custom_tags.yaml'); } ``` @@ -124,13 +124,13 @@ public function prepend( ContainerBuilder $container ) $config = $this->processConfiguration($configuration, $configs); $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); - $loader->load('services.yml'); + $loader->load('services.yaml'); } public function prepend( ContainerBuilder $container ) { $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config')); - $loader->load('custom_tags.yml'); + $loader->load('custom_tags.yaml'); } } ``` diff --git a/docs/tutorials/field_type/1_create_the_bundle.md b/docs/tutorials/field_type/1_create_the_bundle.md index 692cba1c77..7c89368e61 100644 --- a/docs/tutorials/field_type/1_create_the_bundle.md +++ b/docs/tutorials/field_type/1_create_the_bundle.md @@ -46,7 +46,7 @@ Tests/ ``` Feel free to delete the Controller folder, since you won’t use it in this tutorial. It could have been useful, had our Field Type required an interface of its own. -Also, you can safely delete the `Resources/views/Default` folder and `Resources/config/routing.yml` file, as they won't be needed. You should remove the `ez_systems_tweet_field_type` entry from the `app/config/routing.yml` file as well. +Also, you can safely delete the `Resources/views/Default` folder and `Resources/config/routing.yaml` file, as they won't be needed. You should remove the `ez_systems_tweet_field_type` entry from the `app/config/routing.yaml` file as well. ## Structure the bundle diff --git a/docs/tutorials/field_type/3_implement_the_tweet_type_class.md b/docs/tutorials/field_type/3_implement_the_tweet_type_class.md index 9535a9298b..6f23d1a82a 100644 --- a/docs/tutorials/field_type/3_implement_the_tweet_type_class.md +++ b/docs/tutorials/field_type/3_implement_the_tweet_type_class.md @@ -266,7 +266,7 @@ Copy the following files to your bundle's directory: The interface has one method: `getEmbed( $statusUrl )` that returns the embed code as a string when given a tweet's URL. -Next, add the `ezsystems.tweetbundle.twitter.client` service that uses the class above to `Resources/config/services.yml`: +Next, add the `ezsystems.tweetbundle.twitter.client` service that uses the class above to `Resources/config/services.yaml`: ``` yaml services: diff --git a/docs/tutorials/field_type/4_register_the_field_type_as_a_service.md b/docs/tutorials/field_type/4_register_the_field_type_as_a_service.md index 5ca96b56fd..db7a1a446a 100644 --- a/docs/tutorials/field_type/4_register_the_field_type_as_a_service.md +++ b/docs/tutorials/field_type/4_register_the_field_type_as_a_service.md @@ -6,33 +6,33 @@ To complete the implementation, you must register the Field Type with Symfony by creating a service for it. -Services are by default declared by bundles in `Resources/config/services.yml`. +Services are by default declared by bundles in `Resources/config/services.yaml`. ## Using a dedicated file for the Field Type services -In order to be closer to the kernel best practices, you will declare the Field Type services in a custom `fieldtypes.yml` file. +In order to be closer to the kernel best practices, you will declare the Field Type services in a custom `fieldtypes.yaml` file. -All you have to do is instruct the bundle to load this file in addition to `services.yml`. +All you have to do is instruct the bundle to load this file in addition to `services.yaml`. This is done in the extension definition file, `DependencyInjection/EzSystemsTweetFieldTypeExtension.php`, in the `load()` method. Inside this file, find this line: ``` php -$loader->load('services.yml'); +$loader->load('services.yaml'); ``` -This is where the bundle tells Symfony that when parameters are loaded, `services.yml` should be loaded from `Resources/config/` (defined above). +This is where the bundle tells Symfony that when parameters are loaded, `services.yaml` should be loaded from `Resources/config/` (defined above). Add a new line either before or after this one: ``` php -$loader->load('fieldtypes.yml'); +$loader->load('fieldtypes.yaml'); ``` Like most API components, Field Types use the [Symfony service tag mechanism](http://symfony.com/doc/3.4/service_container/tags.html). A service can be assigned one or several tags, with specific parameters. When the dependency injection container is compiled into a PHP file, tags are read by `CompilerPass` implementations that add extra handling for tagged services. Each service tagged as `ezpublish.fieldType` is added to a [registry](http://martinfowler.com/eaaCatalog/registry.html) using the alias argument as its unique identifier (`ezstring`, `ezxmltext`, etc.). Each Field Type must also inherit from the abstract `ezpublish.fieldType` service. This ensures that the initialization steps shared by all Field Types are executed. -Now you can create a YAML file dedicated to the bundle: `Resources/config/fieldtypes.yml` +Now you can create a YAML file dedicated to the bundle: `Resources/config/fieldtypes.yaml` ``` yaml services: diff --git a/docs/tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md b/docs/tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md index 65cd86102b..f46ef592cd 100644 --- a/docs/tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md +++ b/docs/tutorials/field_type/5_implement_the_legacy_storage_engine_converter.md @@ -133,7 +133,7 @@ public function getIndexColumn() Just like a Type, a Legacy Converter needs to be registered and tagged in the service container. The tag is `ezpublish.storageEngine.legacy.converter`, and it requires an `alias` attribute to be set to the Field Type identifier (`eztweet`). -Add this block to `Resources/config/fieldtypes.yml`: +Add this block to `Resources/config/fieldtypes.yaml`: ``` yml services: diff --git a/docs/tutorials/field_type/6_introduce_a_template.md b/docs/tutorials/field_type/6_introduce_a_template.md index 1ba2c013df..7e4f871a34 100644 --- a/docs/tutorials/field_type/6_introduce_a_template.md +++ b/docs/tutorials/field_type/6_introduce_a_template.md @@ -91,13 +91,13 @@ class EzSystemsTweetFieldTypeExtension extends Extension implements PrependExten { public function prepend(ContainerBuilder $container) { - $config = Yaml::parse(file_get_contents(__DIR__.'/../Resources/config/ez_field_templates.yml')); + $config = Yaml::parse(file_get_contents(__DIR__.'/../Resources/config/ez_field_templates.yaml')); $container->prependExtensionConfig('ezpublish', $config); } } ``` -Next, provide the template mapping in `Resources/config/ez_field_templates.yml`: +Next, provide the template mapping in `Resources/config/ez_field_templates.yaml`: ``` yml system: diff --git a/docs/tutorials/field_type/7_allow_adding_and_editing_the_field_in_back_office.md b/docs/tutorials/field_type/7_allow_adding_and_editing_the_field_in_back_office.md index 72f2a8b02c..9c4f28d394 100644 --- a/docs/tutorials/field_type/7_allow_adding_and_editing_the_field_in_back_office.md +++ b/docs/tutorials/field_type/7_allow_adding_and_editing_the_field_in_back_office.md @@ -64,7 +64,7 @@ class FormMapper implements FieldValueFormMapperInterface Next thing is to register the `FormMapper` as a service, so the system knows to use it to automatically add the input field to the Content Type edit form. You can read more about [services and service container in the documentation](../../guide/service_container.md). -To register the `FormMapper` as a service, add the following lines to `Resources/config/fieldtypes.yml`: +To register the `FormMapper` as a service, add the following lines to `Resources/config/fieldtypes.yaml`: ``` yml ezsystems.tweetbundle.fieldtype.eztweet.form_mapper: diff --git a/docs/tutorials/field_type/8_add_a_validation.md b/docs/tutorials/field_type/8_add_a_validation.md index 2559e5692f..a2231dcf75 100644 --- a/docs/tutorials/field_type/8_add_a_validation.md +++ b/docs/tutorials/field_type/8_add_a_validation.md @@ -256,7 +256,7 @@ Then, you can use this `DataTransformer` in the `FormMapper` like this: // (...) ``` Next thing is to tell the system that the `FormMapper` right now works also as `FieldDefinitionFormMapper`. -In order to do that add an extra tag definition in `Resources/config/fieldtypes.yml`: +In order to do that add an extra tag definition in `Resources/config/fieldtypes.yaml`: ``` yml ezsystems.tweetbundle.fieldtype.eztweet.form_mapper: @@ -282,7 +282,7 @@ To do that, create a file containing the view, `Resources/views/platformui/conte {% endblock %} ``` -Register the new template in the configuration by editing the `Resources/config/ez_field_templates.yml` file: +Register the new template in the configuration by editing the `Resources/config/ez_field_templates.yaml` file: ```yml fielddefinition_edit_templates: diff --git a/docs/tutorials/platform_beginner/3_customize_the_front_page.md b/docs/tutorials/platform_beginner/3_customize_the_front_page.md index 8a418644d4..841e323e74 100644 --- a/docs/tutorials/platform_beginner/3_customize_the_front_page.md +++ b/docs/tutorials/platform_beginner/3_customize_the_front_page.md @@ -9,7 +9,7 @@ You will customize this step by instructing Platform to use a custom template to To use a custom template when rendering the root content, create a `content_view` configuration block for `ezpublish`. -Edit `app/config/ezplatform.yml`. Find the `site_group` key and uncomment it. +Edit `app/config/ezplatform.yaml`. Find the `site_group` key and uncomment it. Add the following block under `site_group`, but before `admin_group` (pay attention to indentation: `content_view` should be one level below `site_group`): @@ -299,7 +299,7 @@ Now you need to indicate when this template should be used. The code blocks shown here include the full structure of the YAML file to help you learn where to place new blocks. Be careful not to duplicate existing keys, because YAML does not allow it. -Go back to `app/config/ezplatform.yml` and add the following configuration (under the existing `content_view` and `full` keys:): +Go back to `app/config/ezplatform.yaml` and add the following configuration (under the existing `content_view` and `full` keys:): ``` yaml site_group: diff --git a/docs/tutorials/platform_beginner/4_display_a_list_of_content_items.md b/docs/tutorials/platform_beginner/4_display_a_list_of_content_items.md index 2a2e131374..ecea3748f1 100644 --- a/docs/tutorials/platform_beginner/4_display_a_list_of_content_items.md +++ b/docs/tutorials/platform_beginner/4_display_a_list_of_content_items.md @@ -138,7 +138,7 @@ Let's do this now with the `line` view for Rides. ## Create a line template for Rides -Add a rule for the `ride` template in your `app/config/ezplatform.yml `file. +Add a rule for the `ride` template in your `app/config/ezplatform.yaml `file. `line` should be at the same level as `full`. ``` yaml diff --git a/docs/tutorials/platform_beginner/5_improve_configuration.md b/docs/tutorials/platform_beginner/5_improve_configuration.md index c620cea3a2..4f0f9ab7cd 100644 --- a/docs/tutorials/platform_beginner/5_improve_configuration.md +++ b/docs/tutorials/platform_beginner/5_improve_configuration.md @@ -7,7 +7,7 @@ Image variations are different versions of the same image. You can use them to s So far the images in the ride list are fitted to the templates automatically, and the result does not look good. Now you will create a variation to specify how you want the images to look in detail. -Create a new file: `app/config/image_variations.yml`: +Create a new file: `app/config/image_variations.yaml`: ``` yaml ezpublish: @@ -20,11 +20,11 @@ ezpublish: - {name: geometry/scaledownonly, params: [140, 100]} ``` -At the beginning of the `ezplatform.yml` file (before the `ezpublish` key), add the following lines to import the content of `app/config/image_variations.yml`: +At the beginning of the `ezplatform.yaml` file (before the `ezpublish` key), add the following lines to import the content of `app/config/image_variations.yaml`: ``` yaml imports: - - { resource: image_variations.yml } + - { resource: image_variations.yaml } ``` Next, modify the templates to use these variations. Variation names are provided as parameters when rendering the image content. @@ -51,8 +51,8 @@ Clear cache and refresh the front page. Photos should now have a regular size an In a larger site there are many elements that need configuration. To keep it more organized, you can split parts of configuration into separate files. -As an example, you can separate all content view configuration into its own file. Create an `app/config/views.yml` file. Copy everything under `content_view` from `ezplatform.yml` and move it to the new file. -Remove the corresponding code from `ezplatform.yml`. The `views.yml` should look like this: +As an example, you can separate all content view configuration into its own file. Create an `app/config/views.yaml` file. Copy everything under `content_view` from `ezplatform.yaml` and move it to the new file. +Remove the corresponding code from `ezplatform.yaml`. The `views.yaml` should look like this: ``` yaml ezpublish: @@ -75,8 +75,8 @@ ezpublish: Identifier\ContentType: ride ``` -Import the file in `ezplatform.yml`, like you did with `image_variations.yml`: +Import the file in `ezplatform.yaml`, like you did with `image_variations.yaml`: ``` yaml -- { resource: views.yml } +- { resource: views.yaml } ``` diff --git a/docs/tutorials/platform_beginner/6_embed_content.md b/docs/tutorials/platform_beginner/6_embed_content.md index 7d8e2f1cf5..d90515afd8 100644 --- a/docs/tutorials/platform_beginner/6_embed_content.md +++ b/docs/tutorials/platform_beginner/6_embed_content.md @@ -40,7 +40,7 @@ Go back to one of your existing Rides, edit it and link some Landmarks to it. Now you need to create the line view for Landmarks. -Declare a new override rule in `app/config/views.yml`: +Declare a new override rule in `app/config/views.yaml`: ``` yaml ezpublish: @@ -93,7 +93,7 @@ Create the template for the line view of a Landmark: `app/Resources/views/line/l ``` Like before, you use an image variation here (line 4) and you need to configure it. -Add the following section to `app/config/image_variations.yml`, at the same level as `ride_list`: +Add the following section to `app/config/image_variations.yaml`, at the same level as `ride_list`: ``` yaml landmark_list: @@ -143,7 +143,7 @@ class RideController extends Controller } ``` -Update `app/config/views.yml` to mention the RideController by adding a line with the `controller` key to the view config. +Update `app/config/views.yaml` to mention the RideController by adding a line with the `controller` key to the view config. ``` yaml hl_lines="8" ezpublish: diff --git a/docs/tutorials/platform_beginner/7_enable_account_registration.md b/docs/tutorials/platform_beginner/7_enable_account_registration.md index d805ff6d87..6c2a40fc90 100644 --- a/docs/tutorials/platform_beginner/7_enable_account_registration.md +++ b/docs/tutorials/platform_beginner/7_enable_account_registration.md @@ -16,7 +16,7 @@ Then go to `/register`. The registration form is unstyled, so you ne ## Customize registration forms -In the `app/config/views.yml` file add a `user_registration` key under `site_group`, at the same level as `content_view`: +In the `app/config/views.yaml` file add a `user_registration` key under `site_group`, at the same level as `content_view`: ```yaml ezpublish: @@ -109,7 +109,7 @@ The second template will render the actual fields of the registration form. Crea ``` The third template you need to prepare covers the confirmation page that is displayed when a user completes registration. -First, point to the new template in the configuration. Add a `confirmation` key to `views.yml`: +First, point to the new template in the configuration. Add a `confirmation` key to `views.yaml`: ``` yaml hl_lines="4" user_registration: From e4d33f28095089e3c46b94ea18febd7b27246a83 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Thu, 6 Jun 2019 14:18:37 +0200 Subject: [PATCH 5/9] Configuration overview --- docs/guide/configuration.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 59d6d1bc45..417c84a709 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -10,17 +10,17 @@ However, you can also use XML or PHP formats for configuration. ### Configuration files -REVIEW +Configuration files are located in the `config` folder. +Configuration is provided per package in the `config/packages` folder, +and routes are defined per package in `config/routes`. -Main configuration files are located in the `app/config` folder. +`config/packages/ezplatform.yaml` contains basic configuration (coming from [ezpublish-kernel](https://github.com/ezsystems/ezpublish-kernel)). +It stores, among others, [SiteAccess](siteaccess.md) information and content view config. -- `parameters.yaml` contains infrastructure-related configuration. It is created based on the default settings defined in `parameters.yaml.dist`. -- `config.yaml` contains configuration stemming from Symfony and covers settings such as search engine or cache configuration. -- `ezplatform.yaml` contains general configuration that is specific for eZ Platform, like for example SiteAccess settings. -- `security.yaml` is the place for security-related settings. -- `routing.yaml` defines routes that will be used throughout the application. +Other configuration is provided in respective files, e.g. `config/packages/ezplatform_admin_ui.yaml`, +`config/packages/ezplatform_http_cache.yaml`. -Configuration can be made environment-specific using separate files for each environment. +Configuration can be made environment-specific using separate folders for each environment. These files contain additional settings and point to the general (not environment-specific) configuration that is applied in other cases. !!! tip From 02a19f861cd9fae3cb678ba93ba7485c65f5e0b2 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Thu, 6 Jun 2019 14:58:14 +0200 Subject: [PATCH 6/9] Bundles --- docs/guide/bundles.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/guide/bundles.md b/docs/guide/bundles.md index 7adb587af0..3dab049acc 100644 --- a/docs/guide/bundles.md +++ b/docs/guide/bundles.md @@ -1,9 +1,5 @@ # Bundles -## Dealing with bundles - -eZ Platform is based on the Symfony framework and applies a similar way of organizing the app. Like in Symfony, where ["everything is a bundle"](http://symfony.com/doc/current/book/bundles.html), your eZ Platform application is going to be a collection of bundles. - ### What is a bundle? A bundle in Symfony (and eZ Platform) is a separate part of your application that implements a feature. You can create bundles yourself or make use of available open-source bundles. You can also reuse the bundles you create in other projects or share them with the community. @@ -13,7 +9,6 @@ Many eZ Platform functionalities are provided through separate bundles included ### How to use bundles? All the bundles containing built-in eZ Platform functionalities are installed automatically. -By default, a clean eZ Platform installation also contains an AppBundle where you can place your custom code. You can see a list of other available community-developed bundles on . Refer to their respective pages for instructions on how to install them. @@ -190,7 +185,8 @@ eZConfigManager.add({ ### Configuration -Configuration may go into `app/config`. However, service definitions from `AppBundle` should go into `src/AppBundle/Resources/config`. +You project's configuration is placed in the respective files in `config/packages`. +See [Configuration](configuration.md) for more information. ### Project example @@ -198,7 +194,7 @@ You can see an example of organizing a simple project in the [companion reposito ### Versioning a project -The recommended method is to version the whole ezplatform repository. Per installation configuration should use `parameters.yaml`. +The recommended method is to version the whole ezplatform repository. ## Built-in bundles From 616713c7695e56e03979347b8c384634109340c6 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Wed, 12 Jun 2019 14:08:31 +0200 Subject: [PATCH 7/9] Service names and misc --- docs/community_resources/support_maintenance_faq.md | 7 ++++--- ...nticating_a_user_with_multiple_user_providers.md | 6 +----- .../displaying_children_of_a_content_item.md | 4 ++-- docs/cookbook/using_routereference.md | 6 +----- docs/guide/clustering_aws_s3.md | 3 +-- docs/guide/content_rendering.md | 3 +-- docs/guide/environments.md | 13 ++----------- docs/guide/search.md | 6 ++---- docs/guide/sessions.md | 6 ++---- docs/guide/siteaccess.md | 3 +-- docs/guide/templates.md | 12 ++++-------- 11 files changed, 21 insertions(+), 48 deletions(-) diff --git a/docs/community_resources/support_maintenance_faq.md b/docs/community_resources/support_maintenance_faq.md index 1f794b2881..546939a2a5 100644 --- a/docs/community_resources/support_maintenance_faq.md +++ b/docs/community_resources/support_maintenance_faq.md @@ -98,12 +98,13 @@ rm -rf var/cache/* In order to avoid merge conflicts on important configuration settings during upgrades, moving as much as possible of your configuration to your own files can be a good idea. -All project-specific parameters should be kept in separate files, -e.g. configuration for Landing Page Blocks could be placed in `landing_page_blocks.yaml` which should be imported in `config/ezplatform.yaml`: +All project-specific parameters should be kept in separate files. +For example, configuration for Landing Page Blocks could be placed in `config/packages/landing_page_blocks.yaml`. +You can also place it in `config/landing_page_blocks.yaml`, which should be imported in `config/ezplatform.yaml`: ```yaml imports: - - { resource: landing_page_blocks.yaml } + - { resource: ../landing_page_blocks.yaml } ``` #### How can I implement authentication in an eZ Platform-based project? diff --git a/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md b/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md index e47c350f15..b087fcc1d3 100644 --- a/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md +++ b/docs/cookbook/authenticating_a_user_with_multiple_user_providers.md @@ -53,12 +53,8 @@ security: In `services.yaml`: ``` yaml -parameters: - app.interactive_event_listener.class: App\EventListener\InteractiveLoginListener - services: - app.interactive_event_listener: - class: '%app.interactive_event_listener.class%' + App\EventListener\InteractiveLoginListener: arguments: ['@ezpublish.api.service.user'] tags: - { name: kernel.event_subscriber }  diff --git a/docs/cookbook/displaying_children_of_a_content_item.md b/docs/cookbook/displaying_children_of_a_content_item.md index 2fa44ea84e..c38bba8f1d 100644 --- a/docs/cookbook/displaying_children_of_a_content_item.md +++ b/docs/cookbook/displaying_children_of_a_content_item.md @@ -81,7 +81,7 @@ Configuring for the use of a Custom Controller starts with pointing to it in you ``` yaml folder: - controller: app.controller.folder::showAction + controller: App\Controller\FolderController::showAction template: full/folder.html.twig match: Identifier\ContentType: folder @@ -205,7 +205,7 @@ services: app.criteria.children: class: App\Criteria\Children - app.controller.folder: + App\Controller\FolderController: class: App\Controller\FolderController arguments: - '@ezpublish.api.service.search' diff --git a/docs/cookbook/using_routereference.md b/docs/cookbook/using_routereference.md index 869ab79f7e..2cbb08c53b 100644 --- a/docs/cookbook/using_routereference.md +++ b/docs/cookbook/using_routereference.md @@ -118,12 +118,8 @@ class MyRouteReferenceListener implements EventSubscriberInterface Service declaration (in `config/services.yaml`): ``` yaml -parameters: - app.my_route_reference_listener.class: App\EventListener\MyRouteReferenceListener - services: - app.my_route_reference_listener: - class: '%app.my_route_reference_listener.class%' + App\EventListener\MyRouteReferenceListener: tags: - { name: kernel.event_subscriber } ``` diff --git a/docs/guide/clustering_aws_s3.md b/docs/guide/clustering_aws_s3.md index eba7ac38f3..2cb8a0928a 100644 --- a/docs/guide/clustering_aws_s3.md +++ b/docs/guide/clustering_aws_s3.md @@ -31,8 +31,7 @@ In your eZ Platform configuration, e.g. `config/packages/ezplatform.yml`, set up ``` yaml services: - amazon.s3_client: - class: Aws\S3\S3Client + Aws\S3\S3Client: arguments: - version: latest diff --git a/docs/guide/content_rendering.md b/docs/guide/content_rendering.md index 6a38f2031d..7feba4be10 100644 --- a/docs/guide/content_rendering.md +++ b/docs/guide/content_rendering.md @@ -197,8 +197,7 @@ By default, the [Configured ViewProvider](#configuring-views-the-viewprovider) i ``` yaml services: - appe.my_view_provider: - class: App\Content\MyViewProvider + App\Content\MyViewProvider: tags: - {name: ezpublish.view_provider, type: eZ\Publish\Core\MVC\Symfony\View\ContentView, priority: 30} ``` diff --git a/docs/guide/environments.md b/docs/guide/environments.md index 309c186677..9dd94a3ef9 100644 --- a/docs/guide/environments.md +++ b/docs/guide/environments.md @@ -20,18 +20,9 @@ SetEnvIf Request_URI ".*" SYMFONY_ENV="dev" ## Using custom environments -If you want to use a custom environment (something other than `prod` and `dev`), you need to create the dedicated configuration files for your environment: - -- `config/config_.yaml` -- `config/ezplatform_.yaml` +If you want to use a custom environment (something other than `prod` and `dev`), you need to place dedicated configuration files in a separate folder: +`config/packages//config_.yaml` The name used as `` is the one that can be used as value of the `ENVIRONMENT` variable. -Those files must import the main configuration file, just like the default [`config_dev.yaml`](https://github.com/ezsystems/ezpublish-community/blob/master/ezpublish/config/config_dev.yaml) does: - -``` yaml -imports: - - { resource: config.yaml } -``` - This enables you to override settings defined in the main configuration file, depending on your environment (for example database settings). diff --git a/docs/guide/search.md b/docs/guide/search.md index 6fa48e84a3..3a76c1d64b 100644 --- a/docs/guide/search.md +++ b/docs/guide/search.md @@ -404,8 +404,7 @@ Available tags for Sort Clause handlers in Legacy Storage Engine are: ``` yaml services: -   ezpublish.search.legacy.gateway.criterion_handler.common.content_id: - class: eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\ContentId +   eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler\ContentId: arguments: ['@ezpublish.api.storage_engine.legacy.dbhandler'] tags: - {name: ezpublish.search.legacy.gateway.criterion_handler.content} @@ -415,8 +414,7 @@ services: ##### Example of registering a Depth Sort Clause handler for Location Search ``` yaml -ezpublish.search.legacy.gateway.sort_clause_handler.location.depth: - class: eZ\Publish\Core\Search\Legacy\Content\Location\Gateway\SortClauseHandler\Location\Depth +eZ\Publish\Core\Search\Legacy\Content\Location\Gateway\SortClauseHandler\Location\Depth: arguments: ['@ezpublish.api.storage_engine.legacy.dbhandler'] tags: - {name: ezpublish.search.legacy.gateway.sort_clause_handler.location} diff --git a/docs/guide/sessions.md b/docs/guide/sessions.md index dfe0f24119..eb8c23a1a7 100644 --- a/docs/guide/sessions.md +++ b/docs/guide/sessions.md @@ -149,14 +149,12 @@ parameters: db_time_col: session_time services: - pdo: - class: PDO + PDO: arguments: dsn: 'mysql:dbname=' user: password: - session.handler.pdo: - class: Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler + Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler: arguments: ['@pdo', '%pdo.db_options%'] ``` diff --git a/docs/guide/siteaccess.md b/docs/guide/siteaccess.md index a4d9719e1e..f4c87ecd67 100644 --- a/docs/guide/siteaccess.md +++ b/docs/guide/siteaccess.md @@ -652,8 +652,7 @@ Let's define a simple service which depends on the Repository's ContentService a ```yaml services: - app.test.my_service: - class: App\MyService + App\MyService: arguments: ['@ezpublish.api.service.content'] calls: - [setSiteAccess, ['@ezpublish.siteaccess']] diff --git a/docs/guide/templates.md b/docs/guide/templates.md index 381d15ed6c..95bc157ef4 100644 --- a/docs/guide/templates.md +++ b/docs/guide/templates.md @@ -11,13 +11,13 @@ To apply a template to any part of your webpage, you need three (optionally four Each template must be mentioned in a configuration file together with a definition of the situation in which it is used. You can use the `ezplatform.yaml` file located in the `config/packages` folder, or create your own separate configuration file in that folder that will list all your templates. -!!! note +!!! tip - If you decide to create a new configuration file, you will need to import it by including an import statement in `ezplatform.yaml`. Add the following code at the beginning of `ezplatform.yaml`: + If you create a new configuration file outside the `packages` folder, you will need to import it by including an import statement in `ezplatform.yaml`. Add the following code at the beginning of `ezplatform.yaml`: ``` yaml imports: - - { resource: .yaml } + - { resource: ../.yaml } ``` !!! tip @@ -421,12 +421,8 @@ class PreContentViewListener Service configuration: ``` yaml -parameters: - app.pre_content_view_listener.class: App\EventListener\PreContentViewListener - services: - app.pre_content_view_listener: - class: '%ezdemo.pre_content_view_listener.class%' + App\EventListener\PreContentViewListener: tags: - {name: kernel.event_listener, event: ezpublish.pre_content_view, method: onPreContentView} ``` From 8fc7559312e39c6431f546996e6692cc01e9d30f Mon Sep 17 00:00:00 2001 From: DominikaK Date: Mon, 17 Jun 2019 10:32:26 +0200 Subject: [PATCH 8/9] Fixes after review --- docs/api/extending_the_rest_api.md | 2 +- docs/api/public_php_api_customization.md | 2 +- docs/cookbook/importing_settings_from_a_bundle.md | 2 +- docs/guide/config_back_office.md | 2 +- docs/guide/http_cache.md | 10 +++++----- docs/guide/personalization.md | 6 +++--- docs/guide/security.md | 2 +- docs/releases/ez_platform_v2.4.md | 6 +++--- docs/releases/ez_studio_16.02_release_notes.md | 4 ++-- docs/releases/updating_ez_platform.md | 10 +++++----- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/api/extending_the_rest_api.md b/docs/api/extending_the_rest_api.md index 0ef2c5b733..b828dd92e6 100644 --- a/docs/api/extending_the_rest_api.md +++ b/docs/api/extending_the_rest_api.md @@ -40,7 +40,7 @@ class DefaultController extends BaseController As mentioned earlier, your REST routes are required to use the REST URI prefix. To do so, the easiest way is to import your routing file using this prefix. -**config/packages/routing.yaml** +**config/routing.yaml** ``` yaml myRestBundle_rest_routes: diff --git a/docs/api/public_php_api_customization.md b/docs/api/public_php_api_customization.md index ee71cc1a8d..3e707d74d1 100644 --- a/docs/api/public_php_api_customization.md +++ b/docs/api/public_php_api_customization.md @@ -99,7 +99,7 @@ You are going to generate a "EzSystems\Bundle\CookbookBundle\EzSystemsCookbookBu Do you confirm generation [yes]? yes ``` -The wizard will generate the bundle, check autoloading, and ask about the activation of your bundle. Hit Enter in the answer to both questions to have your bundle automatically added to your kernel (`app/AppKernel.php`) and routes from your bundle added to the existing routes (`config/packages/routing.yaml`). +The wizard will generate the bundle, check autoloading, and ask about the activation of your bundle. Hit Enter in the answer to both questions to have your bundle automatically added to your kernel (`app/AppKernel.php`) and routes from your bundle added to the existing routes (`config/routes.yaml`). **Activation and generation** diff --git a/docs/cookbook/importing_settings_from_a_bundle.md b/docs/cookbook/importing_settings_from_a_bundle.md index 41ca8dbce2..5b003c1e18 100644 --- a/docs/cookbook/importing_settings_from_a_bundle.md +++ b/docs/cookbook/importing_settings_from_a_bundle.md @@ -6,7 +6,7 @@ When developing your website it is best practice to use one or several custom bundles. However, dealing with core bundle semantic configuration can be a bit tedious -if you maintain it in the main `templates/ezplatform.yml` configuration file. +if you maintain it in the main `config/packages/ezplatform.yaml` configuration file. This page shows how to import configuration from a bundle in two ways: the manual way and the implicit way. diff --git a/docs/guide/config_back_office.md b/docs/guide/config_back_office.md index 1dd9b88c77..07a125e33a 100644 --- a/docs/guide/config_back_office.md +++ b/docs/guide/config_back_office.md @@ -4,7 +4,7 @@ Copying large subtrees can cause performance issues, so you can limit the number of Content items that can be copied at once using `ezpublish.system..subtree_operations.copy_subtree.limit` -in `config/packages/ezplatform-admin-ui.yaml`. +in `config/packages/ezplatform_admin_ui.yaml`. The default value is `100`. You can set it to `-1` for no limit, or to `0` to completely disable copying subtrees. diff --git a/docs/guide/http_cache.md b/docs/guide/http_cache.md index 0322db2d7f..ccc6c35934 100644 --- a/docs/guide/http_cache.md +++ b/docs/guide/http_cache.md @@ -298,8 +298,8 @@ ezpublish: It is recommended to use either `config/services.yaml` or the environment variable. - Note that in `config/ezplatform.yaml`, the `purge_server` setting is an array while `purge_server` in - `config/parameters.yaml` and the `HTTPCACHE_PURGE_SERVER` environment variable should be a string. + Note that in `config/ezplatform.yaml`, the `purge_servers` setting is an array + while the `HTTPCACHE_PURGE_SERVER` environment variable should be a string. ##### Fastly service ID and API token @@ -314,11 +314,11 @@ ezpublish: You may specify service ID and token: - - using the `service_id` and `key` settings (sub elements of "fastly") in `app/config/ezplatform.yaml` - - by setting the parameters `fastly_service_id` and `fastly_key` in `app/config/parameters.yaml` + - using the `service_id` and `key` settings (sub elements of "fastly") in `config/packages/ezplatform.yaml` + - by setting the parameters `fastly_service_id` and `fastly_key` in `config/packages/ezplatform-http-cache-fastly.yaml` - by setting the environment variables `FASTLY_SERVICE_ID` and `FASTLY_KEY` - Unless you need different settings per SiteAccess it is recommended to either use `app/config/parameters.yaml` + Unless you need different settings per SiteAccess it is recommended to either use `config/packages/ezplatform.yaml` or the environment variables. ##### Clear the cache diff --git a/docs/guide/personalization.md b/docs/guide/personalization.md index 15269da7c1..54a8f7dd85 100644 --- a/docs/guide/personalization.md +++ b/docs/guide/personalization.md @@ -46,7 +46,7 @@ recommendationBundleRestRoutes: !!! note "Legacy support" - Legacy support is disabled by default. To enable the legacy search engine (requires `ezpublish-kernel` bundle) copy these service definitions to your `app/config/services.yaml` file and uncomment them: + Legacy support is disabled by default. To enable the legacy search engine (requires `ezpublish-kernel` bundle) copy these service definitions to your `config/services.yaml` file and uncomment them: ``` yaml # ez_recommendation.legacy.search_engine: @@ -127,7 +127,7 @@ Place this in a settings file which won't be affected by an update to the Recomm Visitor events (clicks, buys, ...) on the site need to be sent to the Personalization Solution for the recommendations to be calculated. The content types that are marked to be tracked are also exported to the Personalization Engine. Please note that you can only recommend what you track! -By defining the Content Types in the local `app/config/config.yaml` file, the content will be initially exported by a script. After this, it will be kept in sync with the Personalization Solution everytime a change occurs in the eZ Platform back office. +By defining the Content Types in the local `config/packages/config.yaml` file, the content will be initially exported by a script. After this, it will be kept in sync with the Personalization Solution everytime a change occurs in the eZ Platform back office. The bundle's configuration is SiteAccess-aware. This is an example of the settings (in `config.yaml`): @@ -154,7 +154,7 @@ The following parameters need to be included in the settings file: #### Advanced configuration -If the content's author or image are stored in a different Field, you can specify its name in the `parameters.yaml` file: +If the content's author or image are stored in a different Field, you can specify its name in the `services.yaml` file: ``` yaml ez_recommendation.field_identifiers: diff --git a/docs/guide/security.md b/docs/guide/security.md index bcb87e5fce..7ebd4d2681 100644 --- a/docs/guide/security.md +++ b/docs/guide/security.md @@ -19,7 +19,7 @@ security: logout: ~ ``` -And in `config/packages/routing.yaml`: +And in `config/routes.yaml`: ``` yaml login: diff --git a/docs/releases/ez_platform_v2.4.md b/docs/releases/ez_platform_v2.4.md index 432039a469..6f303512ae 100644 --- a/docs/releases/ez_platform_v2.4.md +++ b/docs/releases/ez_platform_v2.4.md @@ -190,7 +190,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa } ``` - 2\. Add the following configuration to `/app/config/config.yaml` + 2\. Add the following configuration to `/app/config/config.yml` ``` yaml lexik_jwt_authentication: @@ -209,7 +209,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa By default `HS256` is used as signature algorithm for generated token but we strongly recommend switching to SSH keys. For more information see [`LexikJWTAuthenticationBundle` installation instruction.](https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#installation) - 3\. Add `EzSystems\EzPlatformPageBuilder\Security\EditorialMode\TokenAuthenticator` authentication provider to `ezpublish_front` firewall before `form_login` in `app/config/security.yaml`: + 3\. Add `EzSystems\EzPlatformPageBuilder\Security\EditorialMode\TokenAuthenticator` authentication provider to `ezpublish_front` firewall before `form_login` in `app/config/security.yml`: ``` yaml security: @@ -224,7 +224,7 @@ You are now able to load multiple Locations at once, using `LocationService->loa # ... ``` - 4\. Make sure that parameter `page_builder.token_authenticator.enabled` has value `true`. If the parameter is not present, add it to `/app/config/config.yaml`: + 4\. Make sure that parameter `page_builder.token_authenticator.enabled` has value `true`. If the parameter is not present, add it to `/app/config/config.yml`: ``` yaml # ... diff --git a/docs/releases/ez_studio_16.02_release_notes.md b/docs/releases/ez_studio_16.02_release_notes.md index bcb553c14e..0787a18049 100644 --- a/docs/releases/ez_studio_16.02_release_notes.md +++ b/docs/releases/ez_studio_16.02_release_notes.md @@ -163,7 +163,7 @@ Caution! If you had custom siteaccesses or languages set up in your installation, a conflict may appear here. This is because new siteaccesses are introduced in Studio demo in this release: "fr" for French, "de" for German and "no" for Norwegian. -To avoid overriding your siteaccesses with the new ones, you need to accept your own changes in the `app/config/ezplatform.yaml` file. +To avoid overriding your siteaccesses with the new ones, you need to accept your own changes in the `app/config/ezplatform.yml` file. If you have no custom siteaccesses or languages and no conflict occurs, you can do one of the following things: @@ -277,6 +277,6 @@ git merge upgrade-1.2.0 Double check the following before you test: -You should now have a new route in` app/config/routing.yaml`: +You should now have a new route in` app/config/routing.yml`: `_ezplatformRepositoryFormsRoutes: resource: "@EzSystemsRepositoryFormsBundle/Resources/config/routing.yaml"` diff --git a/docs/releases/updating_ez_platform.md b/docs/releases/updating_ez_platform.md index 91874ae25f..23c555fc72 100644 --- a/docs/releases/updating_ez_platform.md +++ b/docs/releases/updating_ez_platform.md @@ -261,7 +261,7 @@ Some versions require updates to the database. Look through [the list of databas Since v1.8 you can add a File field to the Form block on a Landing Page. Files uploaded through such a form will be automatically placed in a specific folder in the repository. - If you are upgrading to v1.8 you need to create this folder and assign it to a new specific Section. Then, add them in the config (for example, in `app/config/default_parameters.yaml`, depending on how your configuration is set up): + If you are upgrading to v1.8 you need to create this folder and assign it to a new specific Section. Then, add them in the config (for example, in `app/config/default_parameters.yml`, depending on how your configuration is set up): ``` bash #Location id of the root for form uploads @@ -337,7 +337,7 @@ Some versions require updates to the database. Look through [the list of databas You should also change the character set that is specified in the application config: - In `app/config/config.yaml`, set the following: + In `app/config/config.yml`, set the following: ``` yml doctrine: @@ -346,7 +346,7 @@ Some versions require updates to the database. Look through [the list of databas default: charset: utf8mb4 ``` - Also make the corresponding change in `app/config/dfs/dfs.yaml`. + Also make the corresponding change in `app/config/dfs/dfs.yml`. ##### Page builder @@ -522,13 +522,13 @@ Some versions require updates to the database. Look through [the list of databas The introduction of [support for PostgreSQL](../guide/databases.md#using-postgresql) includes a change in the way database schema is generated. - It is now created based on [YAML configuration](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage/legacy/schema.yaml), using the new [`DoctrineSchemaBundle`](https://github.com/ezsystems/doctrine-dbal-schema). + It is now created based on [YAML configuration](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage/legacy/schema.yml), using the new [`DoctrineSchemaBundle`](https://github.com/ezsystems/doctrine-dbal-schema). If you are updating your application according to the usual procedure, no additional actions are required. However, if you do not update your meta-repository, you need to take two additional steps: - enable `EzSystems\DoctrineSchemaBundle\DoctrineSchemaBundle()` in `AppKernel.php` - - add [`ez_doctrine_schema`](https://github.com/ezsystems/ezplatform/blob/master/app/config/config.yaml#L33) configuration + - add [`ez_doctrine_schema`](https://github.com/ezsystems/ezplatform/blob/master/app/config/config.yml#L33) configuration #### Changes to Matrix Field Type From 80435421f646d2307f3167e14e7856d07b2c56e3 Mon Sep 17 00:00:00 2001 From: DominikaK Date: Tue, 18 Jun 2019 10:49:06 +0200 Subject: [PATCH 9/9] Apply suggestions from code review Co-Authored-By: Michal Milc <48127225+michalmilc90@users.noreply.github.com> Co-Authored-By: MagdalenaZuba <35031941+MagdalenaZuba@users.noreply.github.com> --- docs/api/field_type_search.md | 2 +- docs/api/field_type_storage.md | 6 +++--- docs/api/field_type_type_and_value.md | 2 +- docs/cookbook/making_cross_origin_http_requests.md | 2 +- docs/cookbook/setting_up_multi_language_siteaccesses.md | 2 +- docs/getting_started/troubleshooting.md | 2 +- docs/guide/extending_page.md | 2 +- docs/guide/persistence_cache.md | 2 +- docs/guide/personalization.md | 2 +- docs/releases/updating_ez_platform.md | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/field_type_search.md b/docs/api/field_type_search.md index 2d260aacf4..d44a21e61b 100644 --- a/docs/api/field_type_search.md +++ b/docs/api/field_type_search.md @@ -32,7 +32,7 @@ This method gets name of the default field to be used for sorting. As Field Type ## Register Indexable Implementations -Implement `eZ\Publish\SPI\FieldType\Indexable` as an extra service and register this Service using the `ezpublish.fieldType.indexable` tag. Example from [`indexable_fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/indexable_fieldtypes.yaml): +Implement `eZ\Publish\SPI\FieldType\Indexable` as an extra service and register this Service using the `ezpublish.fieldType.indexable` tag. Example from [`indexable_fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/indexable_fieldtypes.yml): ``` yml ezpublish.fieldType.indexable.ezkeyword: diff --git a/docs/api/field_type_storage.md b/docs/api/field_type_storage.md index cf9e5fc26d..98357a7f9d 100644 --- a/docs/api/field_type_storage.md +++ b/docs/api/field_type_storage.md @@ -59,7 +59,7 @@ The tag has the following attribute: !!! tip - Converter configuration for built-in Field Types is located in [`eZ/Publish/Core/settings/fieldtype_external_storages.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yaml). + Converter configuration for built-in Field Types is located in [`eZ/Publish/Core/settings/fieldtype_external_storages.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yml). ## Storing external data @@ -132,7 +132,7 @@ services: The configuration requires providing the `ezpublish.fieldType.externalStorageHandler` tag, with the `alias` attribute being the *fieldTypeIdentifier*. You also have to inject the gateway in `arguments`, [see below](#gateway-based-storage). -External storage configuration for basic Field Types is located in [eZ/Publish/Core/settings/fieldtype_external_storages.yaml](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yaml). +External storage configuration for basic Field Types is located in [eZ/Publish/Core/settings/fieldtype_external_storages.yaml](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Publish/Core/settings/fieldtype_external_storages.yml). #### Registration @@ -155,4 +155,4 @@ Also note that there can be several gateways per Field Type (one per storage eng !!! tip - Gateway configuration for built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/storage_engines.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage_engines.yaml). + Gateway configuration for built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/storage_engines.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage_engines.yml). diff --git a/docs/api/field_type_type_and_value.md b/docs/api/field_type_type_and_value.md index d37abc800f..b61a2655ae 100644 --- a/docs/api/field_type_type_and_value.md +++ b/docs/api/field_type_type_and_value.md @@ -124,7 +124,7 @@ The `alias` key is the `fieldTypeIdentifier`. !!! tip - The configuration of built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Publish/Core/settings/fieldtypes.yaml). + The configuration of built-in Field Types is located in [`EzPublishCoreBundle/Resources/config/fieldtypes.yaml`](https://github.com/ezsystems/ezpublish-kernel/blob/v7.5.0/eZ/Publish/Core/settings/fieldtypes.yml). ## Field Type settings diff --git a/docs/cookbook/making_cross_origin_http_requests.md b/docs/cookbook/making_cross_origin_http_requests.md index aaede60d6c..92a60931b3 100644 --- a/docs/cookbook/making_cross_origin_http_requests.md +++ b/docs/cookbook/making_cross_origin_http_requests.md @@ -38,7 +38,7 @@ nelmio_cors: #### Changing configuration of NelmioCorsBundle for eZ Platform REST -The default configuration of NelmioCorsBundle for eZ Platform REST paths is set in [nelmio_cors.yaml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yaml) file. +The default configuration of NelmioCorsBundle for eZ Platform REST paths is set in [nelmio_cors.yaml](https://github.com/ezsystems/ezplatform-rest/blob/master/src/bundle/Resources/config/nelmio_cors.yml) file. To adapt these settings to your own needs you have to overwrite them in `nelmio_cors.yaml` file under the same configuration path, for instance: ```yaml diff --git a/docs/cookbook/setting_up_multi_language_siteaccesses.md b/docs/cookbook/setting_up_multi_language_siteaccesses.md index 69284c6d5d..38c09ba4d7 100644 --- a/docs/cookbook/setting_up_multi_language_siteaccesses.md +++ b/docs/cookbook/setting_up_multi_language_siteaccesses.md @@ -97,7 +97,7 @@ Add the new `translation_siteaccesses` here. After the `site_group` you register # templates common to both the en and fr SiteAccess ``` -`ezplatform.yaml` with SiteAccesses should now be configured. Clear to cache to complete the job: +`ezplatform.yaml` with SiteAccesses should now be configured. Clear the cache to complete the job: ``` bash php bin/console cache:clear diff --git a/docs/getting_started/troubleshooting.md b/docs/getting_started/troubleshooting.md index ba5e00a80e..fb6763414c 100644 --- a/docs/getting_started/troubleshooting.md +++ b/docs/getting_started/troubleshooting.md @@ -5,7 +5,7 @@ This page lists potential problems that you may encounter while installing, conf ## Initial installation options If you accepted default options during `composer install`, but need to change some of them later, -you can do it in `.env`. +you can do it in the `.env` file. ## Enable swap on systems with limited RAM diff --git a/docs/guide/extending_page.md b/docs/guide/extending_page.md index 5ed79adbcf..a72c99e4d6 100644 --- a/docs/guide/extending_page.md +++ b/docs/guide/extending_page.md @@ -356,7 +356,7 @@ Some blocks can have slightly more complex configuration. An example is the Collection block, which requires an `options` key. This key defines which Content Types can be added to it. - See [this example from the Studio Demo](https://github.com/ezsystems/ezstudio-demo-bundle/blob/master/Resources/config/default_layouts.yaml#L160): + See [this example from the Studio Demo](https://github.com/ezsystems/ezstudio-demo-bundle/blob/master/Resources/config/default_layouts.yml#L160): ``` yaml blocks: diff --git a/docs/guide/persistence_cache.md b/docs/guide/persistence_cache.md index f783937976..2e355aabc1 100644 --- a/docs/guide/persistence_cache.md +++ b/docs/guide/persistence_cache.md @@ -54,7 +54,7 @@ The underlying cache system is exposed as an `ezpublish.cache_pool` service, and ### Configuration -By default, configuration currently uses **FileSystem** to store cache files, which is defined in [`.env`](https://github.com/ezsystems/ezplatform/blob/master/.env). +By default, configuration currently uses **FileSystem** to store cache files, which is defined in the [`.env` file](https://github.com/ezsystems/ezplatform/blob/master/.env). You can select a different cache backend and configure its parameters in the relevant file in the `cache_pool` folder. #### Multi Repository setup diff --git a/docs/guide/personalization.md b/docs/guide/personalization.md index 54a8f7dd85..75891aa519 100644 --- a/docs/guide/personalization.md +++ b/docs/guide/personalization.md @@ -89,7 +89,7 @@ Allow public HTTP(S) access to the recommendation bundle API (` If the company policy is to use BASIC AUTH on the API interfaces, you need to add some specific configuration. -You probably have some access restrictions on your site defined in app/config/security.yaml +You probably have some access restrictions on your site defined in `app/config/security.yaml` ``` yaml security: diff --git a/docs/releases/updating_ez_platform.md b/docs/releases/updating_ez_platform.md index 23c555fc72..9db9338567 100644 --- a/docs/releases/updating_ez_platform.md +++ b/docs/releases/updating_ez_platform.md @@ -522,7 +522,7 @@ Some versions require updates to the database. Look through [the list of databas The introduction of [support for PostgreSQL](../guide/databases.md#using-postgresql) includes a change in the way database schema is generated. - It is now created based on [YAML configuration](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage/legacy/schema.yml), using the new [`DoctrineSchemaBundle`](https://github.com/ezsystems/doctrine-dbal-schema). + It is now created based on [YAML configuration](https://github.com/ezsystems/ezpublish-kernel/blob/master/eZ/Bundle/EzPublishCoreBundle/Resources/config/storage/legacy/schema.yaml), using the new [`DoctrineSchemaBundle`](https://github.com/ezsystems/doctrine-dbal-schema). If you are updating your application according to the usual procedure, no additional actions are required. However, if you do not update your meta-repository, you need to take two additional steps: