Plugin Directory

Changeset 3023996


Ignore:
Timestamp:
01/19/2024 10:35:32 AM (2 years ago)
Author:
ringier
Message:

doc: mention the following requirement: WordPress cron should be functioning properly

Location:
ringier-bus/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • ringier-bus/trunk/README.md

    r2980105 r3023996  
    1010**Requires PHP:** 8.0.2 
    1111**License:** GPLv2 or later 
    12 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html 
     12**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
    1313
    1414A plugin to push events to the Ringier Event Bus when articles are created, updated or deleted.
     
    2020### BENEFITS
    2121
    22 The Hexagon solutions available via the Ringier Event Bus and compatible with this plugin include: 
    23 - The syncing of articles with Sailthru media library, 
     22The Hexagon solutions available via the Ringier Event Bus and compatible with this plugin include:
     23- The syncing of articles with Sailthru media library,
    2424- The storage of article events in Ringier Datalake, from which they are retrieved by the Content Distribution Engine (CDE). 
    25 You can also benefit from the Bus tooling such as event logging, event monitoring and alerting.
     25  You can also benefit from the Bus tooling such as event logging, event monitoring and alerting.
    2626
    2727To learn more about Hexagon services, visit [https://hexagon.ringier.com/services/business-agility/](https://hexagon.ringier.com/services/business-agility/).
     
    3535The **events are scheduled** to be sent to the Bus **within a 1-minute delay**. This is to allow WordPress to process the changes and update custom fields in the database, which is done asynchronously. You can view scheduled events by making use of the plugin "Advanced Cron Manager".
    3636
    37 The plugin also creates two custom fields, available on the article edition page under "Event Bus". 
    38 - The article lifetime is required by the CDE. 
     37The plugin also creates two custom fields, available on the article edition page under "Event Bus".
     38- The article lifetime is required by the CDE.
    3939- The second field, called "Hidden field", is for internal use. It is made to determine if the article is being created or updated, information which is not available by default on WordPress due to the way articles are saved.
    4040
     
    4444
    4545This plugin requires *PHP version >= 8.0.2*.
    46 But no ***PHP 8.1+ support*** yet since WordPress itself is not officially supported beyond PHP 8.0 at this point in time.
    4746
     47### WordPress Cron Requirement
     48
     49Before installation, ensure that your WordPress cron is functioning properly. This plugin relies on the WordPress cron system for scheduled tasks. If your cron system is not active, please refer to the WordPress Codex or consult with your web hosting provider to enable it.
    4850
    4951### SETUP
    5052
    51 1. The plugin is accessible from the WordPress admin via "Plugins > Add New > Search". 
    52 2. Once you have installed the plugin, a Ringier Bus menu will appear. Please fill in the required fields to set up the plugin. 
     531. The plugin is accessible from the WordPress admin via "Plugins > Add New > Search".
     542. Once you have installed the plugin, a Ringier Bus menu will appear. Please fill in the required fields to set up the plugin.
    53553. In order to get an Event Bus node id, username and password, please contact the bus team via Slack or by email at bus@ringier.co.za to gain access to the Bus admin.   You will be able to add a new node onto the bus and set up your event destinations.
    5456
     
    6163## Contributing ##
    6264
    63 There are many ways you can contribute: 
    64 - Raise an issue if you found one, 
    65 - Provide us with your feedback and suggestions for improvement, 
     65There are many ways you can contribute:
     66- Raise an issue if you found one,
     67- Provide us with your feedback and suggestions for improvement,
    6668- Create a Pull Request with your bug fixes and/or new features. GitHub repository: [https://github.com/RingierIMU/mkt-plugin-wordpress-bus](https://github.com/RingierIMU/mkt-plugin-wordpress-bus)
    6769
    6870## Credits/Thanks ##
    6971
    70 1) [Wasseem Khayrattee](https://github.com/wkhayrattee) - for creating and maintaining the plugin 
     721) [Wasseem Khayrattee](https://github.com/wkhayrattee) - for creating and maintaining the plugin
    71732) Mishka Rasool - for conceiving/creating the [banner](assets/banner.png) and [logo](assets/logo.png) asset files
    7274
  • ringier-bus/trunk/readme.txt

    r2980105 r3023996  
    5252
    5353This plugin requires *PHP version >= 8.0.2*.
    54 But no ***PHP 8.1+ support*** yet  since WordPress itself is not officially supported beyond PHP 8.0 at this point in time.
     54
     55### WordPress Cron Requirement ###
     56
     57Before installation, ensure that your WordPress cron is functioning properly. This plugin relies on the WordPress cron system for scheduled tasks. If your cron system is not active, please refer to the WordPress Codex or consult with your web hosting provider to enable it.
    5558
    5659
Note: See TracChangeset for help on using the changeset viewer.