News of the phpdoc production site

News of the phpdoc production site

Valery Fremaux གིས-
Number of replies: 2

Hi all devs,

I'm still working on complete automation of the phpdocs compilation.

Yet we have a complete set of scripts for checkouting the branch we want and recompile complete documentation for it in one of the phpdocs.moodle.org subvolumes.

1.7 documentation will not be recompiled. We published it for convenience for old implementations who might be still running somewhere.

1.8 documentation is planned to be recompiled once a week. Please argue for telling me what should be the best compilation time (usually, takes less than 15 minutes)

1.9 documentation should be recompiled once a day, at 0.00 GMT (should be*) (it takes also some 15 minutes as far).

We have room and power enough to support the HEAD if there is some real need for.

I plan making a sub compilation for third-party plugins (only plugins, no patches nor themes (meaningless)), but this would rely on a @package rule for all third party developpers (as we need to compile much more code from the core to maintain consistence in documentation links for plugins).

Note for MartinD about package names : I'm afraid we will not be able to use a slash within package names, nor subpackages (not explicitely described in phpdocumentor documentation)

(*) Still to do : all is ready for automation, except the conclusion of a complete ssh-agent driven CVS access for avoiding password prompts. This is the last thing I need working on and seems to be a bit tricky to conclude.

Cheers from Paris !! 

དཔྱ་སྙོམས་ཀྱི་སྐུགས་ཚུ།: -
In reply to Valery Fremaux

Re: News of the phpdoc production site

Martin Dougiamas གིས-
Core developers གི་པར Documentation writers གི་པར Moodle HQ གི་པར Particularly helpful Moodlers གི་པར Plugin developers གི་པར Testers གི་པར
If slash definitely doesn't work then can we standardise on hyphenated version of the paths?

mod-forum
auth-imap

To avoid password prompts the CVS user needs to have a ssh key setup for it. You can create one using:

ssh-keygen -d

and then get the .pub file from your ~/.ssh directory and copy the contents into the account here:

http://moodle.org/cvs
In reply to Martin Dougiamas

Re: News of the phpdoc production site

Valery Fremaux གིས-

Martin,

Hyphen : it works (confirmed by phpdoc doc). I'm OK for this solution. Would we apply for all plugins ? (i.e. mod-data, block-admin, filter-tex ?)

Ssh setup : Yes I did it yesterday and was waiting for my developper account data propagation...

I prepared a :

ssh-agent bash
ssh-add moodle_rsa
...
export CVS_RSH='ssh'
export CVSROOT=rootatmyplace
...
cvs co -r MOODLE_XX_STABLE moodle
...
ssh-agent -k

script but i could not have it working till now. Must try later after propagation.