Scheduler has a couple of pages in the drupal documentation site building guide http://drupal.org/node/108984
Should we link this from the modules main page? If so, how much should be repeated back here?
Do we know if many users read those documentation pages? If not many, then should we keep most of the documentation here, is it ok to duplicate?
If duplicating, maybe we should have the pages formatted so that we can simply copy from here to there, rather than have to edit and make changes twice.
By the way, it says that I created those two pages, but I think that it wrong. If you look at the revision history I started contributing in the middle, but the first text was written by other users. Odd.
Jonathan
Comments
Comment #1
jonathan1055 CreditAttribution: jonathan1055 commentedWe also need to update the readme.txt file to include notes on calendar integration for D7, what hooks scheduler provides for custom interaction with other modules, what integration we provide by default, the current maintainers, and updated installation notes for both D6 and D7
The project front page to usefully include some of this information too.
Comment #1.0
jonathan1055 CreditAttribution: jonathan1055 commentedtypos
Comment #2
jonathan1055 CreditAttribution: jonathan1055 commentedStoring this here - it is an addition for the project front page, to be added after the second paragraph, about entering dates.
New Features and Fixes
We have been working hard on new features, enhancements and bug fixes for the next release. If you use Scheduler, please consider downloading the latest 7.x dev release, testing some of the following issues then giving us your feedback.
If you are new to this, here is a beginners guide to applying patches and some further help on how to apply patches. To see what we have already achieved, here is the list of enhancements and fixes committed for 7.x-1.2
Thank You!
Comment #3
pfrenssenGreat stuff, I have put it on the project page, and tweeted about it. Congratulations on your 7th Drupal birthday!
Comment #4
jonathan1055 CreditAttribution: jonathan1055 commentedThank you for doing that, and thanks for the telling me about my birthday, I had not noticed :-)
Comment #5
pfrenssenThe request to link the documentation on the main project page has already been adressed: it is linked as "Read documentation" underneath "Resources" in the sidebar.
So we still need to work on the readme.
Comment #6
jonathan1055 CreditAttribution: jonathan1055 commentedNow we are nearing 7.x release 1.2 what tasks do we need to do for documenting? Should we create a changelog.txt file? If so, does it just have a copy of everything in #2032911: Enhancements for 7.x-1.2?
Comment #7
pfrenssenI don't think we need a changelog. This information is already readily available in the git history, the release notes, the commit list, ...
I would certainly copy the list of #2032911: Enhancements for 7.x-1.2 to the release notes though.
Comment #8
jonathan1055 CreditAttribution: jonathan1055 commentedOK that's fine with me. I will try to find some good practice guides for readme.txt and update it.
Comment #9
malcomio CreditAttribution: malcomio as a volunteer and at Capgemini commentedNot sure if this issue needs to be open any more.
I've created a guide at https://www.drupal.org/docs/contributed-modules/scheduler - it would be good to link to this from the module page.
Comment #10
jonathan1055 CreditAttribution: jonathan1055 as a volunteer commentedHi malcomio,
Thanks for doing this. I presume you migrated the content from the exitsing doc page https://www.drupal.org/node/108984 ?
That has not been changed for a while, and was out of date. For example, the video by Heather James no longer exists, but we do have a D8 video (see project page).
There are a few other bits which need updating, but I can do that. First I will link it from the project page.
Comment #11
jonathan1055 CreditAttribution: jonathan1055 as a volunteer commentedAlso, did you create that page as 7.x or 8.x? The links on the project page have versions attached.
Comment #12
malcomio CreditAttribution: malcomio as a volunteer and at Capgemini commentedYes, I'd started from that page, and adapted it for D8.
I hadn't checked the video links - I've updated it.