Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README files #107

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 44 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -29,6 +30,8 @@ In order to enable the module in your project run:
./vendor/bin/drush en oe_webtools
```

## Submodules

### OpenEuropa Webtools Analytics

The Webtools module contains a submodule that provides a service for providing
Expand All @@ -38,13 +41,13 @@ check out the module [README](modules/oe_webtools_analytics/README.md).
### 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

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
Expand Down Expand Up @@ -75,6 +78,12 @@ with the maps service.

* [drupal/geofield 1.x](https://www.drupal.org/project/geofield)

#### 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
Expand All @@ -90,9 +99,38 @@ supported media providers.

* [drupal/json_field 1.x-rc3](https://www.drupal.org/project/json_field)

#### Webtools Media Usage

```bash
drush en oe_webtools_media
```

### OpenEuropa Webtools Social Share

The Webtools module contains a submodule that provides social sharing functionality for a site.
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
```

After enabling the module, the configuration can be modified here "admin/config/system/oe_webtools_globan".

## Development setup

Expand Down Expand Up @@ -123,10 +161,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:
Expand All @@ -138,7 +176,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.

Expand Down
22 changes: 14 additions & 8 deletions modules/oe_webtools_analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,27 @@ 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
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';
Expand All @@ -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"
15 changes: 10 additions & 5 deletions modules/oe_webtools_cookie_consent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down