The current readme.txt is very out-of-date. It talks about Drupal 4 and 5, with no mention of 6 or 7, let alone 8. We need to decide what the best practice is, regarding keeping history in the file or deleting all the old stuff and only keeping things relevant to 8.x

A link to this file is given at /admin/help/scheduler. When clicked we just get the plain text displayed in the browser. I wonder if we can do this a better way and display a nicer-to-read page, such as I have seen on other sites, where they have a readme.md (or something like that)

Comments

jonathan1055 created an issue. See original summary.

sandipshirsale’s picture

Assigned: Unassigned » sandipshirsale
sandipshirsale’s picture

Assigned: sandipshirsale » Unassigned
Status: Active » Needs review
StatusFileSize
new7.13 KB

Created a patch file to update readme.txt file for 8.x

jonathan1055’s picture

Assigned: Unassigned » jonathan1055

Thanks @sandipshirsale for starting this.
I have reviewed the patch, and your new readme is mostly just a copy of the project front page. Whilst this is an improvement on the current readme, I think we need to give more information than just that. Plus many things do not need to copied. I will make some changes and post an updated patch.
Jonathan

jonathan1055’s picture

StatusFileSize
new6.33 KB

Here's an update, based on the template at https://www.drupal.org/node/2181737

  • jonathan1055 committed bfe7431 on 8.x-1.x
    Issue #2732223 by jonathan1055: Update readme.txt for 8.x
    

  • jonathan1055 committed bc90851 on 8.x-1.x
    Issue #2732223 by jonathan1055: Second update of README.txt for 8.x
    
jonathan1055’s picture

Assigned: jonathan1055 » Unassigned
Status: Needs review » Fixed

Fixed line spacing and indentation to allign to recommended layouts. Added note about hooks and events. Added previous maintainers.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.