[drupal-docs] Re: SoC Documentation

[Farsheed]

Don't forget to describe in detail what the module
actually does and how to do it!
:)



--- Robert Douglass <rob at robshouse.net> wrote:

> This needs some explanation as my original mail
> hasn't been posted to 
> the docs list. It will probably still show up (it
> got moderated), but 
> here is what it said:
> 
> Hello Summer of Code students and documentation
> list,
> 
> All of the Summer of Code projects are coming to an
> end and we have some 
> really great contributions to be thankful for. The
> code is excellent and 
>   the level of participation from the 11 students
> has been remarkable. 
> But, as we all know, code is not everything. Thus
> commences the autumn 
> of documentation :-)
> 
> SoC students (especially those whose native language
> is not English), 
> please do the following:
> 
> 1) Make sure that you have included, at a minimum,
> README.txt and 
> INSTALL.txt with your projects. Please take some
> time to write the 
> highest quality documentation that you can. Look to
> great modules like 
> the banner module or img_assist for examples of how
> top developers 
> document their code.
> 2) Post your texts to this list and ask for
> assistance with the phrasing 
> and the quality of communication. Having others
> proofread your work is 
> important for any writer. You can also include
> comments from inside your 
> code for people to look at.
> 3) Work with the people on the documentation list
> and incorporate the 
> changes suggested into your documentation.
> 
> 
> Documentation list; please take the time to support
> our SoC students, 
> they've worked really hard so far!
> 
> cheers,
> 
> Robert
> 
> 
> 
> 
> 
> Kuba Zygmunt wrote:
> > Here I added my INSTALL.TXT file for Drupal
> Automated Test Suite (simpletest)
> > 
> > 
> >
>
------------------------------------------------------------------------
> > 
> > Name: Drupal Automated Test Suite
> > Shorter: simpletest
> > License: GPL
> > ---------------------------
> > 
> > How to install?
> > ---------------------------
> > We don't provide a Simpletest PHP Class, on which
> this module is based. You will
> > have to download it by yourself.
> > To make it work properly follow the steps below:
> > 
> > 1. Go to http://www.lastcraft.com/simple_test.php
> and download Simpletest Class
> > 2. Unpack this in
> <drupal_main_dir>/modules/simpletest
> > ( you should have a structure similar to this:
> >  <drupal main dir>
> >   +- database
> >   +- misc
> >   *- modules
> >    *- simpletest (* here is our simpletest class
> *)
> >     +- docs
> >     +- extensions
> >     +- test
> >   +- scripts
> >   +- sites
> >   +- themes
> > 
> > 3. Copy Drupal Simpletest Module's files to your
> module directory
> > After this you should have 6 files in module's
> directory and tests in
> > modules/tests
> > 
> > *- modules
> >  +- tests
> >  drupal_reporter.php
> >  ...
> >  simpletest.module
> > 
> > 4. Load simpletest.module in admin section.
> > 
> > To see articles about writing tests see
> http://drupal.org/simpletest
> > 
> 
> -- 
> [ drupal-docs |
> http://lists.drupal.org/listinfo/drupal-docs ]
> 


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com