Re: Keep documentation for previous versions when updating it to reflect new behaviour and features
JoAnna Springsteen <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
> Part of the original reason for this email is that we had a small burp in > our process. In Plone 3.3, the way versioning is displayed/implemented is > completely different than it is in versions 3.0-3.2. This is the kind of stuff that the framework team shouldn't be doing. tsk tsk. /me wags finger But seriously, as we are more involved with documenting PLIPs, we should catch this kind of thing early and point out the ramifications of making large changes like this. > In the process of > updating this page in the Plone 3 user's manual, we temporarily lost the > page that documented how it worked in the previous versions (it was > overwritten). Would something like working copy support on plone.org help? > The warning here is to make sure to do something like this: > > Versioning (Plone v3.0 - Plone v3.2) > Versioning (Plone v3.3+) > > [from http://plone.org/documentation/manual/plone-3-user-manual/] Yeah, this is ugly but it works. Better than having an entirely new manual for 3.3. > And not to update the current page without retaining the previous > information. again, working copy support ? other ideas? Personally we should be using versioning on our docs anyway. Is this a requirement we've talked about for the upcoming PHC changes? Maybe we should add this? J. ------------------------------------------------------------------------------ Stay on top of everything new and different, both inside and around Java (TM) technology - register by April 22, and save $200 on the JavaOne (SM) conference, June 2-5, 2009, San Francisco. 300 plus technical and hands-on sessions. Register today. Use priority code J9JMT32. http://p.sf.net/sfu/p