Description:
Faq_Ask is a companion module to FAQ, which has already been ported to D6. This module's owner is very busy with several other modules and customers. It would be nice to not only have this module done, but also a handbook page created that can serve as a case study for other module developers.

Deliverables:
1) An upgrade patch to the latest -dev version of Faq_Ask module that is ready to be committed.
2) One or more handbook page(s) that are ready to be published describing the steps and tasks required to convert the module.

Resources:
Project page: http://drupal.org/project/faq_ask
Documentation page: http://drupal.org/node/192806
D5->D6 Conversion page: http://drupal.org/node/114774
Coder module: http://drupal.org/project/coder (may be very useful in identifying the tasks).
FAQ project page: http://drupal.org/project/faq

Primary contact:
Nancy Wichmann: http://drupal.org/user/101412
Email: nan_wich@bellsouth.net

Comments

aclight’s picture

aclight commented
Component: GHOP Task » Task idea
aclight’s picture

aclight commented
Status: Active » Needs work

1.) Is the FAQ_Ask module maintainer on bard with this task and willing to accept a patch at this time?

2.) I don't see why there is a need for the student to create a handbook page to document the steps required to upgrade the module. Shouldn't that be covered by the D5->D6 conversion page?

3.) Could you add a brief description at the beginning of why this task is important in the greater world of Drupal? For example, what does FAQ_Ask module do (1-2 sentences). This helps make your task more attractive to students, IMHO.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

1) I AM the maintainer.
2) The handbook page is a case study for upgrading so that those who have a hard time understanding the conversion stuff can have a concrete example to look at. Sort of "Oh, now I see what they mean!"
3) "...already been ported to D6. The Faq_Ask module allows the user to implement an "Ask the Expert" or advice feature that then feeds the site's FAQs. This module's owner... also a handbook page created that can serve as a case study providing concrete examples of upgrade tasks for other module developers."

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented
Status: Needs work » Active
aclight’s picture

aclight commented
Status: Active » Needs work

Sorry, I didn't realize you were the maintainer for this module also.

I'm not sure how useful a handbook page on this will end up being. Can't people use the coder module to get a start with porting a module to D6, and then go from there? I haven't actually ported anything myself yet, so I could be wrong. There are a lot of changes between D5 and D6, and a quick glance at your module shows that it's relatively small, and my guess is that it's not likely to need a ton of work.

I think I'd rather the task just be porting the module, unless you know this will be really easy, and that's why you added the handbook creation as well.

Maybe you could come up with a separate task that involves the handbook page for upgrading a module. I'm not sure what you'd do here, but if for example the D5->D6 Conversion page lacks examples in a lot of places the task could be providing good examples where they are lacking.

Go ahead and rework the description incorporating the comments and your replies and assuming that looks good I'll RTBC this and you can create the official task. The google task tracker doesn't support HTML so you can just copy and paste your original task proposal into a comment and make the modifications, and then later copy that into Google.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

Yes, Faq_Ask is relatively simple, but contains many of the same elements more complex modules have. I, for one, am confused by a few of the tasks, with menus being the most confusing. The help text "placeholder" also is a bit confusing. Maybe its just me. I guess I like seeing, "Here's what we did for this situation..."

My proposal has no HTML in it.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented
Status: Needs work » Active

Revised:

Description:
-----------
Faq_Ask is a companion module to FAQ, which has already been ported to D6. The Faq_Ask module allows the user to implement an "Ask the Expert" or advice feature that then feeds the site's FAQs. This module's owner is very busy with several other modules and customers. It would be nice to not only have this module done, but also a handbook page created that can serve as a case study providing concrete examples of upgrade tasks for other module developers.

Deliverables:
------------
1) An upgrade patch to the latest -dev version of Faq_Ask module that is ready to be committed.
2) One or more handbook page(s) that are ready to be published describing the steps and tasks required to convert the module.

Resources:
---------
Project page: http://drupal.org/project/faq_ask
Documentation page: http://drupal.org/node/192806
D5->D6 Conversion page: http://drupal.org/node/114774
Coder module: http://drupal.org/project/coder (may be very useful in identifying the tasks).
FAQ project page: http://drupal.org/project/faq

Primary contact:
---------------
Nancy Wichmann: http://drupal.org/user/101412
Email: nan_wich@bellsouth.net

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

I guess I'm not the only one who thinks the upgrade process could use a bit more documentation. http://lists.drupal.org/pipermail/development/2008-January/028434.html

aclight’s picture

aclight commented
Status: Active » Reviewed & tested by the community

I don't doubt that both the module upgrade instructions and the site update instructions could be better. I'm just not sure how helpful a "case study" in updating one specific module for D6 will be, especially since this appears to be a relatively simple module.

The update patch for the module itself should effectively be a guide for how to update this module itself, and I'm not sure how much more the handbook page will add.

But, with that said, we can try it out and see how it goes. I guess that the worst that can happen is that you get your module updated and a somewhat useful handbook page, and that's not that bad.

Go ahead and taskify this according to the instructions at http://groups.drupal.org/node/7360#tasks, starting with the 3rd or 4th bullet point.

nancydru’s picture

nancydru
she/her/hers
Primary language English
Location Boston
commented

http://code.google.com/p/google-highly-open-participation-drupal/issues/...

aclight’s picture

aclight commented
Status: Reviewed & tested by the community » Closed (fixed)