IMO, the project page and/or readme.txt should clearly and prominently state that the Event Repeat module pretty much does not work unless you go to the Settings page to select which kinds of repeats are to be shown and that Cron should be run after installation.

CommentFileSizeAuthor
#3 eventrepeat_documentation.patch9.97 KBseanbfuller

Comments

seanbfuller’s picture

seanbfuller commented

I agree that the README.txt file needs a rewrite. However, did you see the INSTALL.txt file? Steps 3 and 7 mention these steps.

I can incorporate a "To add the advanced options to the event repeat form..." into step 3.

I suppose I should also clean up the README.txt file and make the INSTALL.txt file more prominent.

Do you have any other suggestions?

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

To someone who's never used this module before, that's pretty sketchy. Yes, you should definitely mention the Advanced settings. When I first went there, I didn't realize they were the most important part of the page. All I saw that I wanted to change was the calendar format.

The other thing to mention is that, for whatever strange Drupal reasons, that settings menu entry is out of order. In my system, it is the very last thing under Site configuration - after XML Sitemap - rather than being in the usual alphabetical order.

IMHO, it would also be nice to copy those install instructions to the documentation page. Maybe I can help with that if you would like.

seanbfuller’s picture

seanbfuller commented
Title: Mention Settings prominently » Rewrite documentation
Status: Active » Needs review
StatusFileSize
new eventrepeat_documentation.patch9.97 KB

I spent some time rewriting the documentation. Originally, I was waiting for some of the proposed changes, but as some of these things were causing problems, I decided to go ahead and do it now. Feedback welcome.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

Much better. Thanks.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

Did we lose this in the latest download?

seanbfuller’s picture

seanbfuller commented

The patch has not been committed to 5.x-1.x yet. I'll hopefully get a chance to commit everything and do some additional branching later today or tomorrow.

seanbfuller’s picture

seanbfuller commented
Status: Needs review » Fixed

I've updated both 5.x-1.x and 5.x-2.x with a slightly modified version of this patch that mentions the specific branch of event module that is required.

Anonymous’s picture

(not verified) commented
Status: Fixed » Closed (fixed)