Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:44376
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: error (pb1.pair.com: domain lerdorf.com from 209.85.222.184 cause and error)
Message-ID: <4A3BBF03.5050207@lerdorf.com>
Date: Fri, 19 Jun 2009 09:38:27 -0700
User-Agent: Thunderbird 2.0.0.18 (Macintosh/20081105)
MIME-Version: 1.0
To: PHP Developers Mailing List <internals@lists.php.net>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Subject: Call for a doc push
From: rasmus@lerdorf.com (Rasmus Lerdorf)

Guys and gals, in the old days we had a very close tie between the code
and the documentation.  As the project has grown the two have drifted
apart.  I think this is mostly because the phpdoc team has done an
amazing job keeping up with the code changes and writing awesome
documentation.  This has made us a bit lazy and complacent.

I would like to encourage everyone on this list to spend a little bit of
time looking at the parts of the documentation that cover things you are
familiar with.  Or even just going through some of the doc bugs and
helping out in general.

To get you started:

Checkout the phpdoc tree from cvs
Read the README file

When you make a change, run "php configure.php" to make sure you didn't
break anything, and that is about all you need to know.

If you want to build your own version of the full manual so you can see
exactly what your changes will look like, do:

  pear install doc.php.net/phd-beta

and run the phd script.  It will build the manual and you can create a
local docs vhost to look at it, but this is more work and not really
necessary if you are just tweaking things and adding to already existing
documentation.

Personally I am going to try to make one doc commit per day for the next
little while.

-Rasmus