Hi Simon, (Raises hand and ducks.) Probably I am an "existing maintainer," and I totally agree that the documentation/versioning situation can be better addressed.
The original plan, as I recall it, was that people writing documentation would indicate in the documentation the version from which a newly documented feature was introduced, but this hasn't been universally done (probably including myself), though I recall having seen it done in places. So, one solution would be to make ensure that this plan is executed throughout the documentation and that it continues to be followed. I suggest that where problem areas are discovered, they are simply fixed (e.g., by adding "(Since 1.0.3)" in such places). That said, there are other ways we can solve this, and I'll do some brainstorming on it, think more about the suggestions already provided, and hopefully we'll have a good solution implemented for 1.5.0GA. Thanks for this feedback! :) Best regards, Darby Simon Mundy wrote: > Heh, yeah I _would_ ... but I know nothing about how the manual gets > from the repository to the website :) > > I'll wait to see if any of the existing maintainers put their hand up > and if not then we'll put a prop up on the wiki post-1.5 > > Cheerio > >> To be honest, IMO the documentation situation is far from ideal right >> now, and I can definitely see your point. On the other hand, 1.5. ;) >> Have you considered putting together a proposal and reviewing what >> changes would be required to our release process and build scripts? As >> I'm sure you've noticed, Simon, the best way to get something done in >> framework is to do as much as you can yourself without blocking on any >> Zend involvement. :D Let me know what I can do to help you here, and >> keep in mind that you might get more traction after 1.5 drops. >> >> Thanks. >> ,Wil >> >>> -----Original Message----- >>> From: Simon Mundy [mailto:[EMAIL PROTECTED] >>> Sent: Tuesday, February 05, 2008 6:39 PM >>> To: Wil Sinclair >>> Cc: Zend Mailing List >>> Subject: Documentation on framework site >>> >>> Hi Wil >>> >>> I'm not sure if this has been requested before, but would it be >>> possible to make it slightly clearer on the documentation pages that >>> the manual refers to the current trunk release of the framework? >>> >>> If not that then perhaps hold back updates on the website until a >>> minor/major version has been released. I've seen a few cases where >>> people are confused as the new documentation refers to functionality >>> or changes that haven't yet been released to a stable version. >>> >>> Or perhaps a-la MySQL's site there could be a browseable-by-version >>> page on the site? I'm not sure how automated the current process is so >>> hope I'm not asking for a biggy here :) >>> >>> -- >>> >>> Simon Mundy | Director | PEPTOLAB >>> >>> """ " "" """""" "" "" """"""" " "" """"" " """"" " """""" "" " >>> >>> 202/258 Flinders Lane | Melbourne | Victoria | Australia | 3000 >>> Voice +61 (0) 3 9654 4324 | Mobile 0438 046 061 | Fax +61 (0) 3 9654 >>> 4124 >>> http://www.peptolab.com >> > > -- > > Simon Mundy | Director | PEPTOLAB > > """ " "" """""" "" "" """"""" " "" """"" " """"" " """""" "" " > > 202/258 Flinders Lane | Melbourne | Victoria | Australia | 3000 > Voice +61 (0) 3 9654 4324 | Mobile 0438 046 061 | Fax +61 (0) 3 9654 4124 > http://www.peptolab.com > >
