Our first priority has to be the documentation sprint, but working on
improving the handbook in other ways is always a good idea :)
Here are some thoughts about doing this:
1) The whole set of handbooks doesn't have to be done at once. Perhaps
one book at a time? Or even better, why do we need to do it in bulk?
Can't people be working on a few pages at a time?
2) As Kobus mentions, there's the logistics of keeping people from
posting during the update. Not only that, but we don't want to lose
contributions. This suggests that working on smaller sections at a time
might be a better solution. Could be less disruptive.
puregin wrote:
I like option 2) as an idea, if it could be made to work.
On a related note, I'm hoping we could at some point have a
'documentation freeze'
for the handbook, which would enable us to export the entire beast,
bulk edit it
to spellcheck, grammar check, clean up HTML, and in general whip it
into shape,
and then re-import. This shouldn't take too long (Djun the optimist) -
I'm willing
to work on this.
Djun
On 28 Aug 2005, at 9:01 PM, Charlie Lowe wrote:
With the Drupal feature freeze underway, it won't be long now before
we need to begin a documentation sprint for Drupal 4.7 to update the
existing admin/help documentation that Kieran previously worked so
hard on.
The purpose of this email is to discuss the best process for
achieving this. As I see it, there are two approaches:
1) The Drupal docs team reviews all of the admin/help docs in the
following sections:
http://drupal.org/handbook/modules
http://drupal.org/handbook/config/contribmodules
Problem with this:
* difficult to coordinate
* many contrib modules are not updated until after the release
candidate right before Drupal 4.7 will be official released (if not
afterwards). Depending on how module API's have been changed for this
release (is this a factor?), they may not work until then.
I would imagine we would need to shoot for reviews and updates of the
core modules right before and right after Drupal 4.7 RC.
2) A better way to do this would be to implement an ongoing process,
one that would require the participation of developers. *If* we could
get developers working on modules to submit Documentation issues when
they have made changes to a module which requires a documentaiton
update, we could take care of these on a case-by-base basis, with a
big push to finish up any during the RC release in time for the
stable version. Also, this would allow us to track needed changes to
contrib module documentation and provide patches for subsequent updates.
****
Any thoughts?
Charlie Lowe
--
[ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
http://www.puregin.org
|
