[documentation] Help cleaning up comments

Sun Apr 8 18:12:15 UTC 2007

Hi all,

Is there any way to see who is working on which book pages, or some other
way to organize effort and prevent two people from working on a book page at
the same time? 

Or is that just unlikely to happen at this point?

Trevor

-----Original Message-----
From: documentation-bounces at drupal.org
[mailto:documentation-bounces at drupal.org] On Behalf Of
documentation-request at drupal.org
Sent: Sunday, April 08, 2007 8:00 AM
To: documentation at drupal.org
Subject: documentation Digest, Vol 29, Issue 1

Send documentation mailing list submissions to
	documentation at drupal.org

To subscribe or unsubscribe via the World Wide Web, visit
	http://lists.drupal.org/listinfo/documentation
or, via email, send a message with subject or body 'help' to
	documentation-request at drupal.org

You can reach the person managing the list at
	documentation-owner at drupal.org

When replying, please edit your Subject line so it is more specific than
"Re: Contents of documentation digest..."

Today's Topics:

   1. Help cleaning up comments (Addi Berry)
   2. Re: Help cleaning up comments (Greg Knaddison - GVS)
   3. Re: Help cleaning up comments (Addison Berry)

----------------------------------------------------------------------

Message: 1
Date: Sat, 7 Apr 2007 19:06:36 -0400
From: Addi Berry <addi at rocktreesky.com>
Subject: [documentation] Help cleaning up comments
To: documentation at drupal.org
Message-ID: <8FDF029B-D545-4EB7-BAC6-234BB5822A32 at rocktreesky.com>
Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed

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

------------------------------

Message: 2
Date: Sat, 7 Apr 2007 20:03:00 -0600
From: "Greg Knaddison - GVS" <Greg at GrowingVentureSolutions.com>
Subject: Re: [documentation] Help cleaning up comments
To: "A list for documentation writers" <documentation at drupal.org>
Message-ID:
	<3861c6770704071903i52e22b74v3abe1bc86d992b60 at mail.gmail.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed

On 4/7/07, Addi Berry <addi at rocktreesky.com> wrote:
> 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.

Yay for better handbooks!  Yay for Addi!  Yay docs!

I noticed that many of the remaining pages with lots of comments are SOC
proposals which have interesting discussion that is hard to delete because
it's important to maintain some of the original voice of the authors (e.g.
Boris discussing the need for Jabber modules, or rDouglass' points about
install profiles as SOC projects).  I just wanted to suggest that in the
future these should probably be discussed somewhere that allows and promotes
comments.

I think that's standard now to discuss them elsewhere, and my idea is likely
to be forgotten by spring 2008, but I wanted to share the observation.

Thanks,
Greg

------------------------------

Message: 3
Date: Sat, 7 Apr 2007 22:17:41 -0400
From: Addison Berry <addi at rocktreesky.com>
Subject: Re: [documentation] Help cleaning up comments
To: A list for documentation writers <documentation at drupal.org>
Message-ID: <BFFDA12D-AB29-4663-9F47-C1E29ACB425E at rocktreesky.com>
Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed

On Apr 7, 2007, at 10:03 PM, Greg Knaddison - GVS wrote:

> I noticed that many of the remaining pages with lots of comments are 
> SOC proposals which have interesting discussion that is hard to delete 
> because it's important to maintain some of the original voice of the 
> authors (e.g. Boris discussing the need for Jabber modules, or 
> rDouglass' points about install profiles as SOC projects).  I just 
> wanted to suggest that in the future these should probably be 
> discussed somewhere that allows and promotes comments.

Yes, I have left all of the SoC pages alone since those discussions really
seem like they should be preserved. So, if you come across a SoC page, for
the time being just skip it.  Maybe we can come up with a clever way to
handle those so they won't always show on the w/ comments list (so new
maintainers won't continually go to them to "clean them up".

- Addi

------------------------------

_______________________________________________
documentation mailing list
documentation at drupal.org
http://lists.drupal.org/listinfo/documentation

End of documentation Digest, Vol 29, Issue 1
********************************************