Hello!

I was shocked and appalled today to discover there was not a single docs page on Drupal.org about MailChimp! We've been using it so much at work that I couldn't sit by without getting a main landing page up and url aliased: http://drupal.org/documentation/modules/mailchimp. If I have the time/inclination, I'll add some subpages with more detailed configuration instructions, since it's such a great module/service and it'll help more people be able to install it.

If you could be so kind as to add the link as "Read Documentation" to the Resources section of the project page's sidebar, that would be great, and will help people find the docs more easily.

Thanks!

Comments

levelos’s picture

levelos commented

That's awesome, thanks @arianek! We've actually been hard at work on some documentation, in the form of a collection of README files, but have yet to commit them for the usual lame reasons ;)

We'll definitely port the content over to the handbook pages as well. Thanks again for the initiative and the push. I added a link to the documentation on the project.

arianek’s picture

arianek commented
Status: Active » Fixed

Super - I'll mark this fixed then. Great to hear there's more docs in the pipe - I discovered http://thinkshout.com/blog/2011/06/lev/mailchimp-20-anatomy-drupal-modul... while looking around for docs and am really excited to learn what other features this brings!

If I get around to adding more content, I'll add it in appropriately named subpages so that it doesn't conflict too much if you want to add in big section yourself. Feel free to revamp what I plunked in there - if you can keep the general structure for this top page consistent with eg. http://drupal.org/documentation/modules/field-ui all the better. (Also, it could probably use a technical review just to make sure I've got the D6 vs. D7 features right.)

Just FYI (I'm one of the current Drupal Docs co-leads, so just trying to inform module maintainers of changes coming down the pipe!) any day now there's going to be some minor changes to the docs pages rolled out to Drupal.org - it's just helping enforce that the docs are community managed (sort of like a wiki). But in the future, our plans are to create a separated "curated docs" system that will allow project maintainers to assign maintainers for their docs, so they can have more full control over some more concise/high quality docs.

If you don't get around to posting the docs by then, it'll be a great time to make them more formal and get them posted. ;) But it could be several months yet before this is ready. More info here: #1291058: Discussion: Make a curated docs section/system and here: #1278256: Develop a plan to make it more clear that the current Documentation on drupal.org is community maintained.

Thanks!

arianek’s picture

arianek commented

ps. Also - if you dump the README.txt content into a docs page, someone might just come format it for you...you never know! ;)

levelos’s picture

levelos commented

As an update to this issue, 7.x-2.x docs are now committed in the form of README files for all modules!
http://drupalcode.org/project/mailchimp.git/commitdiff/92d1860

arianek’s picture

arianek commented
Title: Add MailChimp docs page to Project page Resources » Add README docs into online docs
Status: Fixed » Needs work

Yay :) I'm going to keep this one in my queue in case I get the itch to format some docs on a rainy day...

Moving back to needs work and changing title accordingly

arianek’s picture

arianek commented
Issue summary: View changes

fixing html

perignon’s picture

perignon commented
Issue summary: View changes
Status: Needs work » Closed (outdated)