Re: joint documentation site for php.net projects
| From: | Stefan Neufeind | Date: | Wed, 09 Jun 2004 13:21:59 +0000 |
| Subject: | Re: joint documentation site for php.net projects | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969361236@lists.php.net to get a copy of this message | ||
On Wed, 9 Jun 2004 at 15:05:06, Gabor Hojtsy wrote:
> [Note: intentionally crossposted to a lot of addresses.]
Did so as well :-))
> It is a long time TODO item on the phpdoc TODO list, that we should set
> up a website specifically for the documentation team. Now as we are
> preparing for an initial version of the site, and livedocs is in the
> works, a need for a joint documentation website came up, which would
> include information and tools for people working on the php-doc,
> pear-doc, pecl-doc, php-gtk-doc, smarty-doc and livedocs stuff. Since
> livedocs will hopefully help us unify our systems, and share our
> experience and detached development more easily, it would be desirable
> to set up a joint website. It would also help translators to move around
> the projects, and contributors to help out in more than one project.
[...]
I personally like the idea of having a joint documentation. There have been
several people playing (working?) with live-docs in the last few month - but
afaik from the pear-doc-team there is not yet something definitive when we
would have the chance to switch to livedocs (correct me if needed). Meanwhile
since pear-doc only rebuilds once a week one or two people have set up builds
on their private servers that function as a possibility for people without the
possibility for pear-doc-compilation to see if their contributions work or if
there are link-errors etc.
It would also imho be nice to have the projects on a joined doc-site since this
would function as a central source of information.
However, a short while ago in a meeting we've agreed to integrate things like
Wiki-docs and user-contributed notes for the pear-doc. Am I correct that these
projects can be paused for now? How soon do you think the joined doc could come
reality?
Another point that I've lately got involved with is CHM-doc-building from the
pear-doc. Dieter Raber who did build our CHM-docs in the past has a few days
ago assembled a package of his scripts together with basis documentation.
Currently the CHM-docs don't exist for all languages and are not as up-to-date
as the HTML-version. We've talked about reviving the CHM-docs again. Would this
also be not needed, if we join the documentation-forces? Do you also plan to
supply (automatic) CHM-builds on the new server? (Okay, I know there needs to
be some Windows-machine actually to do the final step of putting the CHM-
together.)
> Now I would like to ask you to just think about this a bit, and if you
> are interested in the development, please provide your opinion on how
> would it be best to discuss the further directions (crosspost replies, a
> designated mailing list, personal emails, IRC, or something else?)
Imho a new mailinglist would be a good idea. But I'd vote to first not list it
on lists.php.net to the public. Using crossposts or private emails seems less
practical to me. Everybody interested from the document-teams can join in on
such a new list if he feels like it.
Keep up the idea. I like it - somehow :-))
Stefan