About to harmonize the version policy in /documentation

7 messages Options
Embed this post
Permalink
Alexander Limi () About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
Hi,

We recently fixed the version policy in the Products area by changing the  
list of available versions from having things like Plone 3.1.x to have the  
following list instead:

Plone 3
Plone 2.5
Plone 2.1
Plone 2.0
Plone 1.0

The reasoning is that if these filters are too granular, the value of them  
is lost — a) nobody bothers to log in and update all their version  
information every time there is a minor release of Plone, and b) search  
suffers, since the buckets are unpredictable because of this. In other  
words, we only list what we consider "major" versions (even though that  
definition has changed slightly throughout the years ;).

If there is a product that only works on (e.g.) 3.1.6 and later because of  
some fix, or other special circumstances, it's the job of the author to  
specify this, not the filter. This particular product would be listed as  
"Plone 3" compatible.

I'd like to do the same update for the documentation area, currently the  
list is too granular:

Plone 3.1.x
Plone 3.0.x
Plone 2.5.x
Plone 2.1.x
Plone 2.0.x

The new list would be:

Plone 3
Plone 2.5
Plone 2.1
Plone 2.0

Again, if something is so specific that it only applies to version 3.2.6  
of Plone, then a) the release manager / framework team have not done their  
job in respecting the policy for what can be added, and b) the filters  
would quickly become useless for search purposes anyway. If there is  
indeed such a difference for documentation purposes, it should be noted in  
the particular document it applies to, as you wouldn't want to maintain  
two different documents for Plone 3.1.x and Plone 3.2.x anyway.

Consider this a heads-up, I'll make sure it's done in one go, scripted and  
ready to be used immediately when we switch over. Complaints in a stamped,  
self-addressed envelope to you-know-who. :)

--
Alexander Limi · http://limi.net


------------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It is the best place to buy or sell services for
just about anything Open Source.
http://p.sf.net/sfu/Xq1LFB
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi · http://limi.net

vedaw () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
Regarding the scripting part of this, we should sniff out docs that are not
in one of these categories so we can reflag them for the proper version.

I'm sure you've considered that, but wanted to point it out anyways.

- Veda


On 1/11/09 7:23 PM, "Alexander Limi" <[hidden email]> wrote:

> Hi,

We recently fixed the version policy in the Products area by changing the
>
list of available versions from having things like Plone 3.1.x to have the
>
following list instead:

Plone 3
Plone 2.5
Plone 2.1
Plone 2.0
Plone 1.0

The
> reasoning is that if these filters are too granular, the value of them  
is
> lost ‹ a) nobody bothers to log in and update all their version  
information
> every time there is a minor release of Plone, and b) search  
suffers, since
> the buckets are unpredictable because of this. In other  
words, we only list
> what we consider "major" versions (even though that  
definition has changed
> slightly throughout the years ;).

If there is a product that only works on
> (e.g.) 3.1.6 and later because of  
some fix, or other special circumstances,
> it's the job of the author to  
specify this, not the filter. This particular
> product would be listed as  
"Plone 3" compatible.

I'd like to do the same
> update for the documentation area, currently the  
list is too
> granular:

Plone 3.1.x
Plone 3.0.x
Plone 2.5.x
Plone 2.1.x
Plone 2.0.x

The
> new list would be:

Plone 3
Plone 2.5
Plone 2.1
Plone 2.0

Again, if something
> is so specific that it only applies to version 3.2.6  
of Plone, then a) the
> release manager / framework team have not done their  
job in respecting the
> policy for what can be added, and b) the filters  
would quickly become
> useless for search purposes anyway. If there is  
indeed such a difference for
> documentation purposes, it should be noted in  
the particular document it
> applies to, as you wouldn't want to maintain  
two different documents for
> Plone 3.1.x and Plone 3.2.x anyway.

Consider this a heads-up, I'll make sure
> it's done in one go, scripted and  
ready to be used immediately when we
> switch over. Complaints in a stamped,  
self-addressed envelope to
> you-know-who. :)

--
Alexander Limi ·
> http://limi.net


------------------------------------------------------------
> ------------------
Check out the new SourceForge.net Marketplace.
It is the
> best place to buy or sell services for
just about anything Open
> Source.
http://p.sf.net/sfu/Xq1LFB
___________________________________________
> ____
Plone-docs mailing
> list
[hidden email]
https://lists.sourceforge.net/lists/list
> info/plone-docs



------------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It is the best place to buy or sell services for
just about anything Open Source.
http://p.sf.net/sfu/Xq1LFB
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
On Sun, 11 Jan 2009 19:37:57 -0800, Veda Williams  
<[hidden email]> wrote:

> Regarding the scripting part of this, we should sniff out docs that are  
> not
> in one of these categories so we can reflag them for the proper version.

I'm not sure why we'd want to do this, it's a perfectly valid state to  
have a blank value here, it just means that you apply to all versions of  
Plone.

--
Alexander Limi · http://limi.net


------------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It is the best place to buy or sell services for
just about anything Open Source.
http://p.sf.net/sfu/Xq1LFB
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi · http://limi.net

vedaw () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
If you're removing 3.1, that doesn't mean that it necessarily applies to all
versions. Values assigned to 3.1 would likely need to be reassigned to Plone
3.


On 1/11/09 7:48 PM, "Alexander Limi" <[hidden email]> wrote:

> On Sun, 11 Jan 2009 19:37:57 -0800, Veda Williams  
<[hidden email]> wrote:

>
> Regarding the scripting part of this, we should sniff out docs that are  >
> not
> in one of these categories so we can reflag them for the proper
> version.

I'm not sure why we'd want to do this, it's a perfectly valid state
> to  
have a blank value here, it just means that you apply to all versions of
>
Plone.

--
Alexander Limi ·
> http://limi.net


------------------------------------------------------------
> ------------------
Check out the new SourceForge.net Marketplace.
It is the
> best place to buy or sell services for
just about anything Open
> Source.
http://p.sf.net/sfu/Xq1LFB
___________________________________________
> ____
Plone-docs mailing
> list
[hidden email]
https://lists.sourceforge.net/lists/list
> info/plone-docs



------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
On Mon, Jan 12, 2009 at 10:09 AM, Veda Williams <[hidden email]> wrote:
If you're removing 3.1, that doesn't mean that it necessarily applies to all
versions. Values assigned to 3.1 would likely need to be reassigned to Plone
3.

Yeah, that's what we're doing. Sorry about being unclear. I just said "it will work the same way as for the Products area", where we did this. :)

--
Alexander Limi · http://limi.net

------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Alexander Limi · http://limi.net

vedaw () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
Some javascript/style in this post has been disabled (why?)
Re: [Plone-docs] About to harmonize the version policy in /documentation Heh, see, I told you that you had probably already thought of it. :)


On 1/12/09 10:17 AM, "Alexander Limi" <[hidden email]> wrote:

On Mon, Jan 12, 2009 at 10:09 AM, Veda Williams <[hidden email]> wrote:
If you're removing 3.1, that doesn't mean that it necessarily applies to all
versions. Values assigned to 3.1 would likely need to be reassigned to Plone
3.

Yeah, that's what we're doing. Sorry about being unclear. I just said "it will work the same way as for the Products area", where we did this. :)


------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez () Re: About to harmonize the version policy in /documentation
Reply Threaded More More options
Print post
Permalink
In reply to this post by Alexander Limi
On Mon, Jan 12, 2009 at 4:23 AM, Alexander Limi <[hidden email]> wrote:
Again, if something is so specific that it only applies to version 3.2.6
of Plone, then a) the release manager / framework team have not done their
job in respecting the policy for what can be added, and b) the filters
would quickly become useless for search purposes anyway. If there is
indeed such a difference for documentation purposes, it should be noted in
the particular document it applies to, as you wouldn't want to maintain
two different documents for Plone 3.1.x and Plone 3.2.x anyway.

+1.

Differences between the 3.x series are expected to be very few and small, so maintaining different docs for each version isn't worth it.

-- israel


------------------------------------------------------------------------------
This SF.net email is sponsored by:
SourcForge Community
SourceForge wants to tell your story.
http://p.sf.net/sfu/sf-spreadtheword
_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docs
Israel Saeta Pérez