Re: How to manage notes?

From: Date: Sun, 25 Aug 2002 04:36:19 +0000
Subject: Re: How to manage notes?
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969348280@lists.php.net to get a copy of this message
Hi Victor, --- Victor Boivie <vboivie@home.se> wrote: [...snip...] > > if it contains useful information, incorporate > that > > into the docs > > yourself, and then delete it. (if you are not able > to > > incorporate it > > into the documentation yourself, leave it alone > for > > someone else to > > handle.) > > I don't know how to do that, but I can learn. Have > you got some internal > "how to write the PHP docs"-manual, or similar that > I should read before I > start editing the SGML-files? Yes, there is a how-to in cvs.php.net, in the phpdoc dir, you can get it from either the web interface to cvs.php.net and then pick the file in phpdoc/howto/howto.html.tar.gz, or just use the cvs command to check out that file from the repository. > > The PHP manual for all things PHP, and of course > the > > source code from (at least) the php4 dir on cvs > > (cvs.php.net), and even better if you also are in > the > > documentation team (this list is for that). > > It sounds as if it would be best if I was. Yep, just read the howto, then setup your DocBook/Jade/OpenJade/etc. environment and start adding to the docs. Feel free to ask for help here in the phpdoc list. > > Hope the info above starts you up. For more > details or > > if you are in doubt, subscribe to the notes list > and > > ask us there. Check also the archives at > news.php.net > > to get an idea of the volume of notes and how some > > situations are handled. Usually if you do not know > > something (or are in doubt about a particular > note), > > email the notes list requesting opinions and > surely > > someone will help. > > I'll send all my note-specific questions to that > list in the future. Thanks > for all your help. > > > If you have the time, you can start by cleaning up > the > > manual pages w/ a lot of notes. There are many > > old/outdated/incorrect ones. > > No, really? :) I took at look at the > install.apache-section and removed > about 80% of all notes that either were questions, > answers or logs of > unsuccessful builds. Yep, the problem is that the notes are in the thousands, but the people actively doing editing are but a few (less than a dozen if I am counting correctly). So it is a question of numbers and free time. > This should be done more often IMHO. Sure thing, if you can convince more people to help we all be glad. ===== --- Jesus M. Castagnetto <jmcastagnetto@php.net> __________________________________________________ Do You Yahoo!? Yahoo! Finance - Get real-time stock quotes http://finance.yahoo.com

« previous php.doc (#969348280) next »