From 6450202fdbe478f444e97ac113437217ce28ae35 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Thu, 10 Oct 2019 14:06:01 +0200 Subject: [PATCH 1/4] OPENEUROPA-0000: Update OE Webtools README documentation. --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 53 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 5c124d50..82c03e96 100644 --- a/README.md +++ b/README.md @@ -29,36 +29,36 @@ In order to enable the module in your project run: ./vendor/bin/drush en oe_webtools ``` -### OpenEuropa Webtools Analytics +## OpenEuropa Webtools Analytics The Webtools module contains a submodule that provides a service for providing analytics information. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_analytics/README.md). -### OpenEuropa Webtools Laco Service +## OpenEuropa Webtools Laco Service The Webtools module contains a submodule that provides a service for retrieving -information about language coverage of entity resources. For more information on +information about language coverage of entity resources. For more information on how to use and test this module, check out the module [README](modules/oe_webtools_laco_service/README.md). -### OpenEuropa Webtools Laco Widget +## OpenEuropa Webtools Laco Widget The Webtools module contains a submodule that provides a widget which integrates -with the Laco service. For more information on how to use and configure this module, +with the Laco service. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_laco_widget/README.md). -### OpenEuropa Webtools Geocoding +## OpenEuropa Webtools Geocoding The Webtools module contains a submodule that provides a widget which integrates with the Geocoding service. -#### Requirements for Webtools Geocoding +### Requirements for Webtools Geocoding * [geocoder-php/geocoder 4.x](https://github.com/geocoder-php/Geocoder) * [drupal/geocoder 3.x](https://www.drupal.org/project/geocoder) * [openeuropa/webtools-geocoding-provider](https://github.com/openeuropa/webtools-geocoding-provider) -#### Webtools Geocoding Usage +### Webtools Geocoding Usage If you want to use the Webtools Geocoding service, enable the submodule: @@ -66,33 +66,68 @@ If you want to use the Webtools Geocoding service, enable the submodule: drush en oe_webtools_geocoding ``` -### OpenEuropa Webtools Maps +## OpenEuropa Webtools Maps The Webtools module contains a submodule that provides a widget which integrates with the maps service. -#### Requirements for Webtools Maps +### Requirements for Webtools Maps * [drupal/geofield 1.x](https://www.drupal.org/project/geofield) -### OpenEuropa Webtools Cookie Consent +### Webtools Maps Usage + +```bash +drush en oe_webtools_maps +``` + +## OpenEuropa Webtools Cookie Consent The Webtools module contains a submodule that provides a service for providing Cookie Consent Kit. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_cookie_consent/README.md). -### OpenEuropa Webtools Media +## OpenEuropa Webtools Media The Webtools module contains a submodule that provides webtools widgets as supported media providers. -#### Requirements for Webtools Media +### Requirements for Webtools Media * [drupal/json_field 1.x-rc3](https://www.drupal.org/project/json_field) -### OpenEuropa Webtools Social Share +### Webtools Media Usage + +```bash +drush en oe_webtools_media +``` + +## OpenEuropa Webtools Social Share + +The Webtools module contains a submodule that provides the Social Share block +with buttons for Twitter, Facebook, LinkedIn and E-mail. + +### Webtools Social Share Usage + +```bash +drush en oe_webtools_social_share +``` + +After enabling the module, go to "admin/structure/block" and place the block in a certain region +(e.g. Content region). + +## OpenEuropa Webtools Global Banner + +The Webtools module contains a submodule that provides a Global Banner with +the EU flag and a link to all EU institutions. + +### Webtools Global Banner Usage + +```bash +drush en oe_webtools_globan +``` -The Webtools module contains a submodule that provides social sharing functionality for a site. +After enabling the module, the configuration can be modified here "admin/config/system/oe_webtools_globan". ## Development setup @@ -123,10 +158,10 @@ Your test site will be available at `./build`. ### Using Docker Compose -Alternatively, you can build a development site using [Docker](https://www.docker.com/get-docker) and +Alternatively, you can build a development site using [Docker](https://www.docker.com/get-docker) and [Docker Compose](https://docs.docker.com/compose/) with the provided configuration. -Docker provides the necessary services and tools such as a web server and a database server to get the site running, +Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration. #### Requirements: @@ -138,7 +173,7 @@ regardless of your local host configuration. By default, Docker Compose reads two files, a `docker-compose.yml` and an optional `docker-compose.override.yml` file. By convention, the `docker-compose.yml` contains your base configuration and it's provided by default. -The override file, as its name implies, can contain configuration overrides for existing services or entirely new +The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations. From 8b76c4d6cd9b693c16f87f194cc67ac68a956eba Mon Sep 17 00:00:00 2001 From: Alexandra Date: Thu, 10 Oct 2019 14:26:56 +0200 Subject: [PATCH 2/4] OPENEUROPA-0000: Update README documentation for Webtools Analytics. --- modules/oe_webtools_analytics/README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/modules/oe_webtools_analytics/README.md b/modules/oe_webtools_analytics/README.md index 3cc988e2..88c3ca97 100644 --- a/modules/oe_webtools_analytics/README.md +++ b/modules/oe_webtools_analytics/README.md @@ -17,6 +17,16 @@ start gathering visitor information. ### How to use +#### Enable the module + +```bash +drush en oe_webtools_analytics +``` +Once enabled, the module will provide the minimum required parameters for all +your sites to be tracked. If you wish to fine grain which specific routes are +going to be tracked, you will need to subscribe to the AnalyticsEvent event and +provide your custom logic there. + #### Required configuration In order to be able to track visitors to your site the Webtool Analytics module @@ -24,9 +34,10 @@ needs a default configuration in the form of two variables: * Site ID: This is the unique ID that identifies your site. * Site path: This is the base path that leads to your site. +* Instance: PIWIK server instance (default value "ec.europa.eu") -This configuration can be provided using Drupal 8 configuration system or by -providing details in your sites settings.php file: +This configuration can be provided in 2 ways: +* Set up the following variables in your sites settings.php file: ``` $config['oe_webtools_analytics.settings']['siteID'] = '123'; @@ -35,9 +46,4 @@ $config['oe_webtools_analytics.settings']['instance'] = 'ec.europa.eu'; ``` -#### Enable the module - -Once enabled, the module will provide the minimum required parameters for all -your sites to be tracked. If you wish to fine grain which specific routes are -going to be tracked, you will need to subscribe to the AnalyticsEvent event and -provide your custom logic there. +* Using the settings form located on this path "admin/config/system/oe_webtools_analytics" From 33144f0a175c5d7e8b963b1410023ea8c70559c4 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Thu, 10 Oct 2019 14:34:03 +0200 Subject: [PATCH 3/4] OPENEUROPA-0000: Update README documentation for Webtools CCK. --- modules/oe_webtools_cookie_consent/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/modules/oe_webtools_cookie_consent/README.md b/modules/oe_webtools_cookie_consent/README.md index 21d32934..912880c1 100644 --- a/modules/oe_webtools_cookie_consent/README.md +++ b/modules/oe_webtools_cookie_consent/README.md @@ -15,24 +15,29 @@ For more information see [here](https://webgate.ec.europa.eu/fpfis/wikis/display ## How to use +#### Enable the module + +```bash +drush en oe_webtools_cookie_consent +``` + Simply install the module and all available options will be enabled. Uninstall the module to disable the services. ### Required configuration In order to provide the Cookie Consent functionality the OpenEuropa Webtools Cookie Consent module -needs a default configuration in the form of this variable: - -* Enable Cookie Consent Kit: Enable the CCK banner. +needs a default configuration. -This configuration can be provided using Drupal 8 configuration system or by -providing details in your sites settings.php file: +This configuration can be provided in 2 ways: +* Set up the following variables in your sites settings.php file: ``` $config['oe_webtools_cookie_consent.settings']['banner_popup'] = true; $config['oe_webtools_cookie_consent.settings']['video_popup'] = true; ``` +* Using the settings form located on this path "admin/config/system/oe_webtools_cookie_consent" ## Upgrade to CCK v2 From c801e92230ec96fe946a786f7886419cbcee6596 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Thu, 10 Oct 2019 16:49:42 +0200 Subject: [PATCH 4/4] OPENEUROPA-0000: Update headings in README. --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 82c03e96..b5db577c 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ Webtools are interactive services available to integrate in a website. **Table of contents:** - [Installation](#installation) +- [Submodules](#submodules) - [Development setup](#development-setup) - [Contributing](#contributing) - [Versioning](#versioning) @@ -29,36 +30,38 @@ In order to enable the module in your project run: ./vendor/bin/drush en oe_webtools ``` -## OpenEuropa Webtools Analytics +## Submodules + +### OpenEuropa Webtools Analytics The Webtools module contains a submodule that provides a service for providing analytics information. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_analytics/README.md). -## OpenEuropa Webtools Laco Service +### OpenEuropa Webtools Laco Service The Webtools module contains a submodule that provides a service for retrieving information about language coverage of entity resources. For more information on how to use and test this module, check out the module [README](modules/oe_webtools_laco_service/README.md). -## OpenEuropa Webtools Laco Widget +### OpenEuropa Webtools Laco Widget The Webtools module contains a submodule that provides a widget which integrates with the Laco service. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_laco_widget/README.md). -## OpenEuropa Webtools Geocoding +### OpenEuropa Webtools Geocoding The Webtools module contains a submodule that provides a widget which integrates with the Geocoding service. -### Requirements for Webtools Geocoding +#### Requirements for Webtools Geocoding * [geocoder-php/geocoder 4.x](https://github.com/geocoder-php/Geocoder) * [drupal/geocoder 3.x](https://www.drupal.org/project/geocoder) * [openeuropa/webtools-geocoding-provider](https://github.com/openeuropa/webtools-geocoding-provider) -### Webtools Geocoding Usage +#### Webtools Geocoding Usage If you want to use the Webtools Geocoding service, enable the submodule: @@ -66,48 +69,48 @@ If you want to use the Webtools Geocoding service, enable the submodule: drush en oe_webtools_geocoding ``` -## OpenEuropa Webtools Maps +### OpenEuropa Webtools Maps The Webtools module contains a submodule that provides a widget which integrates with the maps service. -### Requirements for Webtools Maps +#### Requirements for Webtools Maps * [drupal/geofield 1.x](https://www.drupal.org/project/geofield) -### Webtools Maps Usage +#### Webtools Maps Usage ```bash drush en oe_webtools_maps ``` -## OpenEuropa Webtools Cookie Consent +### OpenEuropa Webtools Cookie Consent The Webtools module contains a submodule that provides a service for providing Cookie Consent Kit. For more information on how to use and configure this module, check out the module [README](modules/oe_webtools_cookie_consent/README.md). -## OpenEuropa Webtools Media +### OpenEuropa Webtools Media The Webtools module contains a submodule that provides webtools widgets as supported media providers. -### Requirements for Webtools Media +#### Requirements for Webtools Media * [drupal/json_field 1.x-rc3](https://www.drupal.org/project/json_field) -### Webtools Media Usage +#### Webtools Media Usage ```bash drush en oe_webtools_media ``` -## OpenEuropa Webtools Social Share +### OpenEuropa Webtools Social Share The Webtools module contains a submodule that provides the Social Share block with buttons for Twitter, Facebook, LinkedIn and E-mail. -### Webtools Social Share Usage +#### Webtools Social Share Usage ```bash drush en oe_webtools_social_share @@ -116,12 +119,12 @@ drush en oe_webtools_social_share After enabling the module, go to "admin/structure/block" and place the block in a certain region (e.g. Content region). -## OpenEuropa Webtools Global Banner +### OpenEuropa Webtools Global Banner The Webtools module contains a submodule that provides a Global Banner with the EU flag and a link to all EU institutions. -### Webtools Global Banner Usage +#### Webtools Global Banner Usage ```bash drush en oe_webtools_globan