Description: Cheat sheets are a compressed list of useful commands, functions, and tips in order to help accomplishing a certain task. This GHOP task would be to create such a cheat sheet for Drupal module development. Using this cheat sheet these basic tasks should be able to be done without needing to use the handbook.

An initial suggestion on what should be included on this sheet:

The module development cheat sheet should contain references for the following tasks:
- All hooks defined by core and their parameters.
- All Drupal database functions and their parameters.
- All form API elements and properties.
- A list of commonly used core functions and their parameters, such as drupal_set_message(), watchdog(), node_load(), etc.

The task is complete when a sheet (with at most two sides, so it can be printed on one piece of paper) is assembled in US letter size, and a downloadable pdf and png is presented and accepted.

Use a design that can display much information, for example similar to those below on ilovejackdaniels.com, but feel free to come up with your own approach as long you provide the required information.

Resources:
* Useful examples on cheat sheets: http://www.ilovejackdaniels.com/cheat-sheets/

Primary contact:
* Brad "beeradb" Bowman

Comments

beeradb’s picture

beeradb commented

Description: Cheat sheets are a compressed list of useful commands, functions, overall helping tips in order to help accomplishing a certain task. This GHOP task would be to create such a cheat sheet for Drupal core hooks. Using this cheat sheet these basic hooks should be accessable without the need to look them up in the handbook.

An initial suggestion on what should be included on this sheet:

The Drupal hooks cheat sheet should contain the following references for each hook:
- All hooks defined by core and their parameters.
- A brief description of each hook.
- A core implimentation of the hook, i.e. forum_form in forum.module

The task is complete when a sheet (with at most two sides, so it can be printed on one piece of paper) is assembled in US letter size, and a downloadable pdf and png is presented and accepted.

Use a design that can display much information, for example similar to those below on ilovejackdaniels.com, but feel free to come up with your own approach as long you provide the required information.

Resources:
* Useful examples on cheat sheets: http://www.ilovejackdaniels.com/cheat-sheets/

Primary contact:
* Brad "beeradb" Bowman

beeradb’s picture

beeradb commented

Description: Cheat sheets are a compressed list of useful commands, functions, overall helping tips in order to help accomplishing a certain task. This GHOP task would be to create such a cheat sheet for Drupal core hooks. Using this cheat sheet these basic hooks should be accessable without the need to look them up in the handbook.

An initial suggestion on what should be included on this sheet:

The Drupal hooks cheat sheet should contain the following references for each hook:
- All hooks defined by core and their parameters.
- A brief description of each hook.
- A core implementation of the hook, i.e. forum_form in forum.module

The task is complete when a sheet (with at most two sides, so it can be printed on one piece of paper) is assembled in US letter size, and a downloadable pdf and png is presented and accepted.

Use a design that can display much information, for example similar to those below on ilovejackdaniels.com, but feel free to come up with your own approach as long you provide the required information.

Resources:
* Useful examples on cheat sheets: http://www.ilovejackdaniels.com/cheat-sheets/

Primary contact:
* Brad "beeradb" Bowman

aclight’s picture

aclight commented
Status: Active » Needs work

The Drupal hooks cheat sheet should contain the following references for each hook:
- All hooks defined by core and their parameters.
- A brief description of each hook.
- A core implementation of the hook, i.e. forum_form in forum.module

I'm not sure if there will be enough space on 2 faces of a page to get the hooks, their prarmeters, description, *and* an implementation of the hook. At least not without making the print pretty small.

Outside of that, a few things you could clarify:
1. Which version of Drupal? D6 HEAD, I presume.
2. Should the cheat sheet have just the parameters, or a 1-2 line description of the parameter itself?
3. Maybe this cheat sheet should be uploaded to the handbooks somewhere (once completed) instead of just to this issue.

Can you also rewrite this slightly so there is a defined "Deliverables" section. This makes scanning of tasks to see what's required much easier.

beeradb’s picture

beeradb commented

Description: Cheat sheets are a compressed list of useful commands, functions, overall helping tips in order to help accomplishing a certain task. This GHOP task would be to create such a cheat sheet for Drupal 6 core hooks. Using this cheat sheet these basic hooks should be accessable without the need to look them up in the handbook.

An initial suggestion on what should be included on this sheet:

The Drupal hooks cheat sheet should contain the following references for each hook:
- A function prototype for each hook defined in core.
- A brief description of each hook defined in core.
- A reference to where you may find a the hook implemented in core.

The deliverable will be a downloadable pdf or png in US letter size, with at most two sides, so it can be printed on one piece of paper.

Use a design that can display much information, for example similar to those below on ilovejackdaniels.com, but feel free to come up with your own approach as long you provide the required information.

Resources:
* Useful examples on cheat sheets: http://www.ilovejackdaniels.com/cheat-sheets/
* For information on function prototypes: http://en.wikipedia.org/wiki/Function_prototype

Primary contact:
* Brad "beeradb" Bowman

beeradb’s picture

beeradb commented

just a note on not including the "upload to handbook" stuff in the task - I didn't do this because it would require adding the student to the documentation team, and with the minimal amount of time remaining in the GHOP program I didn't want to place potential roadblocks for completion.

beeradb’s picture

beeradb commented
Status: Needs work » Needs review
aclight’s picture

aclight commented
Status: Needs review » Reviewed & tested by the community

Looks good to me. Go ahead and taskify this.

About the handbook, anyone can create a handbook page, but you have to be on the doc team to edit a page someone else created. But that's fine if you don't want to include this in the task--I just want to make sure there's a plan for where to put this so it doesn't get lost after the task is completed.

beeradb’s picture

beeradb commented
Status: Reviewed & tested by the community » Fixed

This can be found at http://drupal.org/node/212648

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.