RE: [PHP-DOC] User commentary in docs

2010-04-08 Thread Bill Salak
-Original Message- From: Hannes Magnusson [mailto:hannes.magnus...@gmail.com] Sent: Thursday, April 08, 2010 6:01 AM To: Bill Salak Cc: Rasmus Lerdorf; PHP Documentation List Subject: Re: [PHP-DOC] User commentary in docs On Wed, Apr 7, 2010 at 06:41, Bill Salak wrote: >&

Re: [PHP-DOC] User commentary in docs

2010-04-08 Thread Hannes Magnusson
On Wed, Apr 7, 2010 at 06:41, Bill Salak wrote: >>Yes, documentation is tricky.  People, especially PHP users, come from so > many different experience backgrounds that it is almost impossible to write > one set of docs that speaks to everyone.  There are things in the user > comments that I have

RE: [PHP-DOC] User commentary in docs

2010-04-06 Thread Bill Salak
>Yes, documentation is tricky. People, especially PHP users, come from so many different experience backgrounds that it is almost impossible to write one set of docs that speaks to everyone. There are things in the user comments that I have seen people pick up on that I would have thought was com

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Stelian Mocanita
Hello everyone. The user notes is a great resource to most new users. However there are snippets of junk there that are not only useless, but they even get confusing at some time. I think there would be great to start a program of checking such comments, I can help if needed (not yet involved in th

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rich Bowen
On Apr 6, 2010, at 12:56 PM, Philip Olson wrote: if you want to support user commentary, the only sane way is to regularly peruse those comments, trash the garbage, and incorporate the reasonable comments into the documentation proper. just leaving the comments there in perpetuity is, IMHO, a

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rasmus Lerdorf
On 04/06/2010 09:52 AM, Rich Bowen wrote: > > On Apr 6, 2010, at 12:05 PM, Rasmus Lerdorf wrote: > >> It's custom code for our docs, but it probably wouldn't be too hard to >> bolt onto another system. Start here: > > Thanks so much for the thorough summary. This is very helpful. > > As to whe

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Philip Olson
On Apr 6, 2010, at 9:41 AM, Robert P. J. Day wrote: > On Tue, 6 Apr 2010, Rich Bowen wrote: > >> A few of us on the Apache HTTP Server documentation team are >> investigating what it would take to add a user commentary system to >> the Apache HTTPD docs, like that used on the PHP docs. What soft

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rich Bowen
On Apr 6, 2010, at 12:41 PM, Robert P. J. Day wrote: http://www.php.net/manual/en/language.variables.php if you look closely at that page, it's simply a ***table of contents***, fer cryin' out loud. nevertheless, numerous commenters found it necessary to expound on it. for what conceivable

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Robert P. J. Day
On Tue, 6 Apr 2010, Rasmus Lerdorf wrote: > Robert, you could pitch in and help clean up and incorporate the > comments then. I am sure Dan and the others would appreciate the > help. > There is simply too much user feedback and too few volunteers to get > them all into the documentation in a ti

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rich Bowen
On Apr 6, 2010, at 12:05 PM, Rasmus Lerdorf wrote: It's custom code for our docs, but it probably wouldn't be too hard to bolt onto another system. Start here: Thanks so much for the thorough summary. This is very helpful. As to whether we'll actually do this, I don't know. Expect a certain

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rasmus Lerdorf
On 04/06/2010 09:41 AM, Robert P. J. Day wrote: > On Tue, 6 Apr 2010, Rich Bowen wrote: > >> A few of us on the Apache HTTP Server documentation team are >> investigating what it would take to add a user commentary system to >> the Apache HTTPD docs, like that used on the PHP docs. What software >

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Daniel Brown
On Tue, Apr 6, 2010 at 12:41, Robert P. J. Day wrote: > >  if you want to support user commentary, the only sane way is to > regularly peruse those comments, trash the garbage, and incorporate > the reasonable comments into the documentation proper.  just leaving > the comments there in perpetuity

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Robert P. J. Day
On Tue, 6 Apr 2010, Rich Bowen wrote: > A few of us on the Apache HTTP Server documentation team are > investigating what it would take to add a user commentary system to > the Apache HTTPD docs, like that used on the PHP docs. What software > is used for that? Is it easily reusable in other place

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rasmus Lerdorf
On 04/06/2010 08:25 AM, Philip Olson wrote: > > On Apr 6, 2010, at 7:56 AM, Rich Bowen wrote: > >> A few of us on the Apache HTTP Server documentation team are investigating >> what it would take to add a user commentary system to the Apache HTTPD docs, >> like that used on the PHP docs. What s

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Rasmus Lerdorf
On 04/06/2010 07:56 AM, Rich Bowen wrote: > A few of us on the Apache HTTP Server documentation team are > investigating what it would take to add a user commentary system to the > Apache HTTPD docs, like that used on the PHP docs. What software is used > for that? Is it easily reusable in other pl

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Philip Olson
On Apr 6, 2010, at 7:56 AM, Rich Bowen wrote: > A few of us on the Apache HTTP Server documentation team are investigating > what it would take to add a user commentary system to the Apache HTTPD docs, > like that used on the PHP docs. What software is used for that? Is it easily > reusable in

Re: [PHP-DOC] User commentary in docs

2010-04-06 Thread Daniel Brown
On Tue, Apr 6, 2010 at 10:56, Rich Bowen wrote: > A few of us on the Apache HTTP Server documentation team are investigating > what it would take to add a user commentary system to the Apache HTTPD docs, > like that used on the PHP docs. What software is used for that? Is it easily > reusable in o

[PHP-DOC] User commentary in docs

2010-04-06 Thread Rich Bowen
A few of us on the Apache HTTP Server documentation team are investigating what it would take to add a user commentary system to the Apache HTTPD docs, like that used on the PHP docs. What software is used for that? Is it easily reusable in other places? Where can I get some more info about