[documentation] Help cleaning up comments

[Kieran Lal]

Hi Addi, thanks for  doing this.  When I had
http://drupal.org/handbook/<http://drupal.org/handbook/comments>
comments <http://drupal.org/handbook/comments> made over a year ago, I hoped
someone like yourself would step forward to do this.

Over the last couple of years Dries has encouraged the documentation team to
publish more posts to the front page of Drupal.org.  I think  if you could
summarize your effort into a call to action that this is a worthy story of
the Drupal.org front page.

Be sure to run it by Steven Peck, the docs maintainer, first.

Cheers,
Kieran

On 4/7/07, Addi Berry <addi at rocktreesky.com> wrote:
>
> Hello fellow doc maintainers,
>
> Since I became a site maintainer at OSCMS a few weeks back I have
> been on a mission to delete comments from the handbooks.  I have been
> chipping away at the list and as of writing this email there are only
> 19 pages that have more than 10 comments each to them. I have been
> deleting useless comments (thanks and support requests) and rolling
> in useful ones. There are literally hundreds (maybe 500+?) pages with
> comments and so I am asking for a little help here.
>
> Doc maintainers cannot delete comments but you can roll comments into
> the handbook and identify comments that can be deleted.  What do I
> mean by roll them in?  Glad you asked. :) Here is a little step by step:
>
> 1. Go to the list of pages with comments: http://drupal.org/handbook/
> comments (you can also find this in the Contributor Links block on d.o)
> 2. Pick a page, start at the bottom for those with only 2 comments or
> start at the top for the biggies.
> 3. Read the page, read the comments and determine if there is useful
> info/corrections in the comments.
> 4. Roll it:
>         a. if there are corrections or additional info that would be good
> to
> have in the page - please edit the page.
>         b. if there is extra goodness that is not good for that page, copy
> the comment into a new page (normally a good location is as a child
> page of where you are). I also normally make sure to add a note to
> the log giving the original comment poster credit (e.g. "from comment
> by username")
> 5. Kill it: Once you roll in the useful bits (or if there are no
> useful bits) create an issue for a site admin to delete the
> comments.  Just name the issue Delete Comments, make it a task and
> provide links to the page(s). Feel free to create one issue that
> lists a whole bunch of pages that need comments deleted (when I did
> this, I just opened a notepad on my puter and copy/pasted the URL of
> each page I worked on, then copied the whole list into an issue). The
> more the merrier.
>
> Note: if you aren't sure about all of the comments or weren't able to
> roll them in but think they are still useful you can also post an
> issue that says, delete all the comments except x, y and z, where x,
> y and z are a list of the URL directly to the comment or the title of
> the comment.
>
> I will be checking the issue queue for comment deletions pretty much
> all the time and if you have questions or want an immediate purge,
> you can always try to catch me on IRC.  I'm normally hanging out in
> #drupal or #drupal-dojo whenever I'm online (IRC nick is add1sun).
>
> Thanks for your help and remember, Doc maintainers Rule! (and make
> the world a better place)
> - Addi
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



-- 
To strive, to seek, to find, and not to yield.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.drupal.org/pipermail/documentation/attachments/20070414/c7f8b875/attachment.htm