Problem/Motivation

Documentation and project page are out of date compared to module function.

The syntax for README.md as laid out in https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

The new admin UI with split entry textboxes, and regular expressions being available for excluding cache tags.

Proposed resolution

Update the README and project home page with latest syntax and information about the module.

Create usage guide on d.o.
Update the project page.

Remaining tasks

  • ✅ File an issue
  • ✅ Addition/Change/Update/Fix
  • ✅ Readability
  • ✅ Release notes snippet
  • ✅ Release: 2.0.1 & 8.x-1.1
  • X Update project home page to reduce text load
  • X Add to contributed module guide

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

elc created an issue. See original summary.

elc’s picture

Issue summary: View changes
Status: Active » Needs work

  • elc committed 64445032 on 2.x
    [#3524723] Update README with new features.
    

  • elc committed b0e9cd96 on 8.x-1.x
    [#3524723] Update README with new features.
    
elc’s picture

Assigned: elc » Unassigned
Issue summary: View changes
Status: Needs work » Fixed

Project page updated.

elc’s picture

Title: Update README and project page » Update README, project page and add online documentation
Assigned: Unassigned » elc
Issue summary: View changes
Status: Fixed » Needs work

Re-opening this to achieve:

  • Reduce the amount of text on the project page to minimum needed to describe the function
  • Move the existing use cases and instructions to the contributed module guide.

There will not be mode code merged into the module, just changes to the presence on d.o.

elc’s picture

Assigned: elc » Unassigned
Issue summary: View changes
Status: Needs work » Fixed

After consideration, the project page is fine. Better to give people the information they need then and there rather than bump them off to other parts of a site.

Status: Fixed » Closed (fixed)

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