Documentation update

Hi all,

I've taken a first stab at writing up the documentation aimed at test suite maintainers using the Test Framework. It should eventually land at:

    http://w3c-test.org/framework/docs/maintainer/

whenever the cron job syncs it, but in the meantime it's at:

    http://dvcs.w3.org/hg/testframework/raw-file/tip/docs/maintainer/index.html

It probably needs a few more iterations before it's really usable — in order to get there your feedback is very much welcome. Note that I would really appreciate this being double-checked, the content there is mostly based on reading the code and toying with it a little — and my brain's PHP implementation is only so good.

There are a few things of specific note:

    • I'm not sure what those fields are for test suite manifests: references, revision, credits.

    • Specifications can be imported from the CLI using a spec manifest — is this exposed to the Web interface? (I don't think so). Should it be? Is this how multipage specifications are supposed to be handled? Right now I haven't documented this aspect.

    • The test runs I could find seem to necessitate manual intervention (you see each test one by one, submit the result you see). Yet I see a number of mentions of automated test suite submission. Is this something that's planned for but not supported, or did I miss something? Is there agreement on how it ought to work?

Thanks!

-- 
Robin Berjon - http://berjon.com/ - @robinberjon

Received on Tuesday, 10 January 2012 15:49:01 UTC