Re: Keep documentation for previous versions when updating it to reflect new behaviour and features

Darci Hanning <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On Sun, Apr 19, 2009 at 12:52 PM, Raphael Ritz <[email protected]
> wrote:

> Veda Williams wrote:
> > Within a given version, we can still indicate where something applies to
> 3.3
> > or 3.4 within the 3.x manual, since there will obviously be incremental
> > change, but I don't think we should have new manuals for minor versions
> of
> > Plone, just from the maintenance standpoint.
>
> Once we have the manual in place - and it looks like we come a long way
> already - I'm not sure it would produce much of a maintenance overhead
> to even release the manual for minor versions.
>

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. 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).

The warning here is to make sure to do something like this:

   - Versioning (Plone v3.0 - Plone
v3.2)<http://plone.org/documentation/manual/plone-3-user-manual/managing-content/versioning-plone-v3.0-plone-v3.2>
   - Versioning (Plone
v3.3+)<http://plone.org/documentation/manual/plone-3-user-manual/managing-content/versioning-plone-v3.3>

[from http://plone.org/documentation/manual/plone-3-user-manual/]

And not to update the current page without retaining the previous
information.

Cheers,
Darci

------------------------------------------------------------------------------
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

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.