On Tue, Jun 25, 2013 at 5:10 AM, Johannes Schlüter
<johan...@schlueters.de>wrote:

> On Tue, 2013-06-25 at 08:46 +0200, Christian Stoller wrote:
> > Hi internals.
> >
> > What do you think about moving the PHP documentation to a Git
> > repository, mirrored on Github? Doing this would make it possible for
> > everybody to extend the documentation easily by creating pull
> > requests.
>
> Basically that is good. To the best of my knowledge the issue though, is
> not will but time. Migrating the docs is not just converting the repo,
> like with PECL repos but changing the supporting infrastructure. For
> instance there are tools which help to identify outdated translations
> and the mentioned editor which all have to be adopted. If you want to
> help there the docs group certainly would welcome it.
>
> That aside: resources is also the issue with the online editor. We have
> too few people working on docs, so in the end it doesn't make much
> difference if they don't have time to review edit.php.net or github.
> (while reviewing on edit.php.net has the benefit that it can directly
> validate the docbook, github can't)
>

I'm all for docs moving to git, but I have to say it would be a purely
cosmetic move. This won't change the pace at which our patches are getting
through or the fact that the lack of man-power can be overwhelming for
docs. The documentation is over 10,000 pages and growing with multiple
translations. PHP also suffers from a problem where patches go into php-src
that never get into the changelog for some reason and end up becoming
documentation bugs. I've definitely fixed a number of those in
bugs.php.netand I know I'm not the only one that has complained about
this problem.
It's hard to keep up with the pace at which PHP changes and consistently
document that.

I will say that we do need more people helping out with docs before we
should consider investing the resources in moving docs to git. Again, this
move would only serve to be superficial in the long-run.


>
> johannes
>   (who is one of the bad people not really actively helping with docs)
>

So YOU'RE the one! (*kidding* it's been a while since I've made some
commits myself)


>
>
> --
> PHP Internals - PHP Runtime Development Mailing List
> To unsubscribe, visit: http://www.php.net/unsub.php
>
>

Reply via email to