Re: Requirements for Documentation System

From: Date: Mon, 12 Apr 2004 21:57:32 +0000
Subject: Re: Requirements for Documentation System
References: 1 2 3  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3285@lists.php.net to get a copy of this message
> >> Paul says that package owners who are not members of PEAR-DOC should > >> be able to edit their package docs, and not the docs of packages they do > >> not own, but further discussion may be needed (Arnaud?). > > > > I think pear-dev, qa, doc groups should be able to make any changes. > > If something goes amiss it should be easy to reverse the situation. > > Keeping too tight a workflow will prevent more than encourage imho. > > Agreed. How is this for a rephrase? "Package owners will be allowed > editing privileges on documentation for their packages. PEAR-DEV, -QA, > and -DOC members will be allowed full editing privileges to all > documentation regardless of ownership." That leaves the question, what defines a PEAR-DEV member. Anyone with a PEAR account? Anyone with a PHPCVS account? You say the package manager can only edit his own docs, but isn't(shouldn't?) the package-manger be on PEAR-DEV aswell, thus granting him full access? I'd suggest giving PEAR-QA and a registered PEAR-DOC list full access to the docs. You don't want someone subscribing to PEAR-DOC via the interface, going in there and ruining all the docs, which will then instantly be updated on the website. Can you say D3F4C3-M3? ;) > >>> 5. Fast turnaround between edits and displayed results. > > Modifications should be visible pretty quickly. > For me "quickly" means "as soon as the changes are saved." Is that OK > with everyone? Instantly only works if you have a trusted team. if you open up the docs to anyone out there you will end up with problems. > Anyone else have ideas? The ability to rollback an edit. Not just for the defacing scriptkiddies or drunk devs who decide that BEERISGOOD looks better then the DB Examples on the current page. Also logging what gets changed on the mailing-list would be helpfull for the -DOC'ers to see what's going on. Cipri

« previous php.pear.doc (#3285) next »