Include Drupal 8 Documentation on the Module Project Page

Created on 22 December 2017, over 7 years ago
Updated 14 January 2025, 3 months ago

Problem/Motivation

As a follow up to Document how to create cron jobs 📌 Document how to create cron jobs Fixed , where we worked on updating the 8.x version of this module to have more information about how to configure cron jobs an issue was raised that the project page should be updated to contain information how to use the D8 version as well.

Currently the project page reflects only information about the 7.x version and this could lead to a misleading understaning that the 8.x version does not work properly, as it does not work the same way the D7 version did. As there is an 8.x version out, the project page should reflect information how to use both versions, because the module is too good to allow new people trying it out, to come to a conclusion that the 8.x version does not work properly. That would be ashame, because of the effort put into porting this awesome module to D8.

Proposed resolution

Devide the project page into separate parts, making it clear what information is about the 7.x version and what is about 8.x. Even though the 8.x version is currently an alpha release i would suggest adding information about it after the brief module overview paragraph and on top of the 7.x version information as the 8.x version is for the newest version of Drupal and this is a common practise for other contrib modules which have 8.x and 7.x versions.

The 8.x part should in general should provide the same infomration the 7.x has - how to declare what are the features, how to declare a new cron job and what are the options on configuration.

📌 Task
Status

Active

Version

2.0

Component

Documentation

Created by

🇪🇪Estonia ainarend

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇧🇪Belgium borisson_ Mechelen, 🇧🇪

    I agree that the documentation is not up to date as-is and we should update it to be clearer, was just looking into how to set this up and we could only find the link to the drupal 7 documentation, with a big banner saying that drupal 7 is no longer maintained.

    Can we make sure the drupal 8 documentation is on drupal.org, or place a prominent link on the module homepage to the readme.txt?

Production build 0.71.5 2024