os2web/os2web_meetings_acadre

Import meetings from Acadre ESDH system

dev-master 2024-06-20 07:34 UTC

This package is auto-updated.

Last update: 2024-11-20 08:53:27 UTC


README

Module purpose

The aim of this module is to import meetings from Acadre ESDH providers.

This module is highly dependent on Os2web Meetings module and serves as an implementation of it.

How does it work

Meetings are being imported from so called agenda or manifest files, that are provided by specific Acadre ESDH provider.

OS2Web Meetings Acadre serves as an adapter that converts meetings into a canonical format.

After "translating" each meeting is then processed and eventually imported in the system.

Import is handled via Migrate API, which is part of the Drupal 8 core functionality.

Additional settings

Settings are available under admin/config/system/os2web-meetings

  • Acadre Meetings manifests path - Path to agenda directory.

Install

Module is available to download via composer.

composer require os2web/os2web_meetings_acadre
drush en os2web_meetings_acadre

Import process

The import process can be done in two ways:

  • Via Drush (recommended)

    • Use the following Drush command to start the migration:
      drush migrate:import os2web_meetings_acadre_import
      
      Read more about the Drush commands for Migrate API on Migrate tools.
    • It is highly recommended to set up a cronjob on your server to do the run this command often
  • Via Admin UI

    • Go to admin/structure/migrate/manage/os2web_meetings/migrations on your installation
    • Click Execute next to Meeting import (Acadre)
    • Click Execute on the next page as well (doing that will use default options).

Update

Updating process for OS2Web Meetings module is similar to usual Drupal 8 module. Use Composer's built-in command for listing packages that have updates available:

composer outdated os2web/os2web_meetings_acadre

Automated testing and code quality

See OS2Web testing and CI information

Contribution

Project is opened for new features and os course bugfixes. If you have any suggestion or you found a bug in project, you are very welcome to create an issue in github repository issue tracker. For issue description there is expected that you will provide clear and sufficient information about your feature request or bug report.

Code review policy

See OS2Web code review policy

Git name convention

See OS2Web git name convention