The task is review the status of 'examples for developers' module user interface, and provide results about the efectivity of the current UI implementation, with suggestion about how to organize the different components and where additiona guidance is required to understand the example being demonstrated.

An student with Drupal programing knowledge is prefered.

Preparation and task list

  • Get a copy of Drupal and "examples for developers" module and install them.
  • Verify that all components are discoverable and they include an abstract about what the component does
  • Go through each one of the examples module component and perform the following review
    • Verify that component is discoverable and fully browseable from the Drupal interface
    • Verify that component includes a little explanation about how it works, and how to interact with this example
    • Verify that component operations can be tested manually and seen as the description of the component indicates

Deliverables

The student should fill an issue in the issue queue for each 'examples for developers' component with the following conditions:

  • An abstract about the understanding and browseable status of the module component
  • Detail what was found wrong, not discoverable and not browseable
  • Detail the places where additional guidance about the component's behaviour and documentation are recommended to understand what is the example doing.

Additionally, the student should define a way to centralize all the components documentation and guidances suggested, acting as a landing point for the 'examples for developers' module. This definition does not require additional coding or work, but some feedback and brainstorming in the related project issue: http://drupal.org/node/761334 Organize Examples in a way that the whole project can be understood.

Resources

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

Examples project at drupal.org: http://drupal.org/project/examples
Drupal API site: http://api.drupal.org/api/7
Doxygen formatting conventions: http://drupal.org/node/1354
How to work with patches: http://drupal.org/patch/create
Drupal coding standards: http://drupal.org/coding-standards

Primary Contact

Charlie Gordon, ( cwgordon7 on irc or http://drupal.org/user/157412/contact form)

Could mentor: ilo

Drupal issue

http://drupal.org/node/761334

Comments

ilo’s picture

ilo commented
Status: Active » Needs review

I forgot to set as NR

vosechu’s picture

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

So good it hurts.

cwgordon7’s picture

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

Sorry, this has a few problems:

An student with Drupal programing knowledge is prefered.

This may be problematic. I don't think very many 13 - 18 year old high school students already have Drupal programming knowledge, and we don't want to discourage students from learning how to program with Drupal.

Also, I don't see the value of this task. Maybe it's just me, but I don't consider looking through example modules to find UI bugs or inaccessible components to be a priority. I don't think this is at all prevalent, in the first place; secondly they're just example modules, so as long as they demonstrate the concepts well, there shouldn't be any problems, should there?

I'd appreciate more reviews on this idea from other community members. Thanks!

vosechu’s picture

vosechu commented

These are valid comments, but I think the point is that good programmers learn by looking at good code. If you want people to adhere to UI guidelines then their primary examples had better adhere to them as well. If the Examples for Developers is a wasteland with old style then we have some serious problems down the line.