I'll help with documentation
rconstantine - February 7, 2008 - 01:21
| Project: | Notifications |
| Version: | 5.x-1.x-dev |
| Component: | Documentation |
| Category: | task |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed |
Jump to:
Description
If you can provide me with a list of URLs (not steps, I'll figure that out) that are a step by step walkthrough of setting up this module (and perhaps messaging as well - I might as well make sure that it's correct as well, and I think you need docs for that too), then I'll put together the best descriptions as I can which you can then review and add to before I create a final version for inclusion as a README. If you check out most of the READMEs for my own modules, I think I do a decent job.
Also, if you could perhaps take some screen shots of your own setup, that would be helpful.
#1
This sounds cool. We should be doing next some help pages too.
However this is not as simple as it sounds, as you may have noticed, because there are just too many modules and options around so I think we better focus in a few use cases.
Maybe first we'd need some better descriptions for the modules because I'm seeing people just enables them all and then they are logically overwhelmed by loads of options everywhere.
Basic Steps for all cases should be
- Enable notifications and messaging modules.
- Set up messaging: Administer > Site configuration > Messaging
- Set up notifications: Administer > Notifications > Settings
Then, I.e. for having links for story subscriptions:
- Enable notifications_content and notifications_ui modules
- Review permissions (Notifications and Notifications content)
- Review new settings:
Administer > Notifications > Settings > Content subscriptions
Administer > Notifications > Settings > User Interface
(Here enable the subscription types you want to see/allow)
- Enable subscription links for stories:
Administer > Content Management > Content types > Story
(Set Subscriptions UI option to "As node links")
Now you should see the subscribe /unsubscribe links below your story.
And an overview of your subscriptions at: My account > Notifications
Just don't spend too much time adding screenshots for now because we may be still adding/moving around some options in the next weeks.
#2
Documentation is now here, http://drupal.org/node/252592
New pages and comments are welcomed there.