Hello,
We have historically generated MediaWiki documentation on the Subversion
server known as formey:
https://svn.wikimedia.org/doc/
That the result of running doxygen once per day against the master
branch of mediawiki/core.git.
We would like to move the documentation to another host and I think it
is a good time to change the URL as well to something a bit more
meaningful than
svn.mediawiki.org :-]
We also have auto generated documentation for our puppet manifest at:
http://doc.wikimedia.org/puppet/
Timo and I kind of disagree on the URL scheme to use to publish the
documentation, so instead of starting a revert war in Gerrit, I thought
it would be a good idea to ask some more people to participate in.
For the context:
We would like to have documentation generated for:
- puppet
- mediawiki branches and tags (PHP + JS + CSS)
- mediawiki extensions (PHP + JS + CSS)
The hosts
doc.wikimedia.org and
doc.mediawiki.org points to the same
machine.
I guess puppet could land at
doc.wikimedia.org/puppet
For MediaWiki we need the following parameters:
- project (core / extension name)
- version (tag / release branch / master)
- type of documented source (php / js / css)
What kind of magic ordering can we agree on?
A)
http://doc.wikimedia.org/mediawiki-core/<branch|tag>/php
Would bring:
doc.wikimedia.org/mediawiki-core/master/php
doc.wikimedia.org/mediawiki-core/master/js
doc.wikimedia.org/mediawiki-core/1.20.2/php
doc.wikimedia.org/mediawiki-core/REL1_20/js
doc.wikimedia.org/mediawiki-AbuseFilter/1.20.2/php
B)
doc.mediawiki.org/<project>/<type>/<version>/
Would bring:
doc.mediawiki.org/core/php/master
doc.mediawiki.org/core/js/master
doc.mediawiki.org/core/php/1.20.2
doc.mediawiki.org/core/js/REL1_20
doc.mediawiki.org/AbuseFilter/php/REL1_20
Other thoughts?
I would prefer having the MediaWiki doc hosted on the
mediawiki.org
domain. As for the ordering I guess we can bikeshed for a long time but
most probably some ordering will seem natural for most people there :-]
Thanks!
--
Antoine "hashar" Musso