D7 module dev tutorial

tags

Just gave this a quick look through...

http://drupal.org/node/1074360

- for the "Other modules, including contrib and core" bullet, you might want to link to the main modules page http://drupal.org/project/modules
- for "Drupal documentation" it should link to /documentation

http://drupal.org/node/1074362

- shouldn't the initial module file go into /sites/all/modules? i'm not a "developer" really, but i'm not sure why it would go elsewhere particularly if it's *not* a multisite install. (definitely want a second opinion here!)
- under "coding standards" the "As per the Coding standards, omit the closing ?> tag." closing php tag should probably be in code tags inline.

http://drupal.org/node/1075072

- re: help hooks. they really shouldn't be considered optional, but recommended. there is a standard for d7 help hooks: http://drupal.org/node/632280 that should be followed for contrib (all core modules use this). would be great to link to the standard page.

hope that's relatively helpful! we should try and grab someone for a technical review for sure. try on irc? if you need any comments deleted, ping me. ;)

Ah interesting re: the location of custom modules. I would think the book author probably knows better than me, so unless we get an opinion saying otherwise, should be fine. ;)

That's great for the last page. Not sure if I'll be online much later, but probably tomorrow (before I fly home Friday). Will keep an eye on here though!

Putting custom modules in sites/default/modules vs. sites/all/modules is indeed just a matter of opinion. We recommend putting all custom and contrib modules into sites/all/modules in the INSTALL.txt file distributed with Drupal, so I think we should stick to the same idea in our module dev guide.

great - i'll keep checking in on this whenever i skim the queue. ;)

Just looked at first three:

- so i think the first lines of those pages "Main topic described:" should be removed. though useful, they break from our standard page format and the info can be moved into the introductory sentence if it's not totally clear in the page title (which would be optimal).

- headings/title should use sentence case (only capitalize first word and any proper names). it's not consistent, and should be updated on all pages so that titles and all headings use this. only exception is headings with filenames at the start, like on http://drupal.org/node/1075072 ".Info File Details" should actually be non caps because of the file name --> ".info file details"

- any page paths should be formatted like this "...bla bla on the Modules administration page (Administer > Modules or http://example.com/admin/modules)..." don't think this was in too many spots but i caught one.

(will review the others in a bit!)

And the last 4:

Also just noticed where you do "Important: ..." we normally do a separate paragraph in italics starting with "Please note:" just a small nitpick. ;)

And on second thought, those bolded first lines... despite being not so in line with our typical page style, I'm starting to realize they might actually be really good for people to know they're on the right page. Let's just leave em!

Style looks great. Not sure if you need another tech review, if so post and I'll try and find someone to do one.

Might I add: THESE DOCS ARE FANTASTIC. The writing style, clarify, formatting, etc. are all top notch. So glad to have you on board!

Style/format reviewed those - looking great! Wow, I have no edits to suggest!

Only nitpick is that I'd prefer the paths to config pages to have both the clickthrough path and the URL like the example in the bullets on http://drupal.org/contribute/documentation/guide/style#paths eg. "...on the Modules administration page (Administration > Modules or http://example.com/admin/modules). It's just a suggested format to add that, but I think a lot of people find it useful to be able to cut and paste the path rather than click.

I'll keep doing style reviews if you post more pages here, and if nobody gets a tech review in then once you have a full list of pages to review, I can try and find someone to do the tech review.

Can you post a full list of URLs for the pages needing technical review once they're all there? Once they're ready I'll see if I can find someone to do a full read through. :)

Great effort! I will give this all a read-through as soon as I find the time. Thanks!

We should explain the choice of -A in git add -A. I'm glad to edit it myself but don't have time at the moment. I added the explanation.

This documentation is very well done! I reviewed the first 7 pages today and marked them as "No known problems". I'll continue reviewing the rest of the tutorial this week.