Survey:

Should we move the module documentation from the README to pages in the Drupal.org handbooks? I had a discussion about this at DrupalCON, and we only want to maintain docs in one place.

Thoughts? Volunteers?

Comments

stevector’s picture

stevector
he/him
commented

I think this could be worth doing just to get screenshots and charts into the documentation. The README can contain a URL for the d.o docs.

jduguid’s picture

jduguid commented

I think this would be very helpful. I see a one page description in documentation. Has anyone taken up this task? I'd be willing to volunteer my time on the documentation.

agentrickard’s picture

agentrickard
he/him
Primary language English
Location Georgia (US)
commented

Please do. Right now, it's just a matter of transcribing the README files to handbook format.

See http://drupal.org/documentation-writers-guide

stevector’s picture

stevector
he/him
commented

I have patch that converts the README to Advanced Help. That might aid the move to d.o docs. #1117364: Advanced Help

stevector’s picture

stevector
he/him
commented
Status: Needs review » Needs work

agentrickard summarized well the reasons to do d.o docs instead of Advanced Help here: #1162898: Advanced Help documentation The Workbench team discussed this today and decided that handbook pages will be the priority over Advanced Help. We talked about possibly linking to the handbook from within Advanced Help. I don't think a final decision was reached on whether or not to do that.

I have started moving the README to the handbook. Once the READMEs for all Workbench modules are in handbook form there is a good deal of interlinking that can be done between them.

Workbench Handbook: http://drupal.org/node/1171018

agentrickard’s picture

agentrickard
he/him
Primary language English
Location Georgia (US)
commented
Status: Needs work » Closed (fixed)