You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@syncope.apache.org by Christian Schneider <ch...@die-schneider.net> on 2013/02/13 09:49:10 UTC

[Discuss] Adding a version number to the Wiki pages for releases

Hi all,

our current wiki pages for the minor releases only have names. While
experienced syncope users may already know which version number this
correlates to new users will have no clue.

So I propose to add the version number to the names of the wiki pages
like this:

0.5 - Crescendo
0.6 - Sostenuto
0.7 - Ritornello
1.0 - Espressivo
1.1 - Ad libitum

What do you think?

Christian

-- 
Christian Schneider
http://www.liquid-reality.de

Open Source Architect
http://www.talend.com


Re: [Discuss] Adding a version number to the Wiki pages for releases

Posted by Francesco Chicchiriccò <il...@apache.org>.
On 13/02/2013 11:56, Christian Schneider wrote:
> I think labels would not help a lot. Labels allow to mark several pages
> to belong to the same theme. But we need just one page per version.
>
> This is how camel does it:
> http://camel.apache.org/download.html
> http://camel.apache.org/camel-2103-release.html
> http://camel.apache.org/camel-295-release.html
>
> Basically I like the idea of one page per Version. In syncope we
> currently have one page per Minor version and list all bugfix versions
> inside the same page which is also ok.
> So the only thing I am missing is the version number in the page title
> and the url. This allows at camel to look at a url and instantly know
> that it is about.

Fine for me, then: once done we will have to update 
http://syncope.apache.org/downloads.html to adjust release notes URL.

Regards.

> On 13.02.2013 11:31, Francesco Chicchiriccò wrote:
>> On 13/02/2013 10:41, Christian Schneider wrote:
>>> I think the release pages are not really versioned content like code.
>>> All pages are visible in parallel.
>> Of course...
>>
>>> The name only makes it easier for users to see what each release is.
>> Look at what Atlassian does for Confluence own documentation:
>>
>> https://confluence.atlassian.com/display/CONF35/Confluence+Documentation+Home
>>
>>
>> https://confluence.atlassian.com/display/CONF40/Confluence+Documentation+Home
>>
>>
>>
>> This is definitely too much: what if we empower page labels for this?
>> Take as example the label "practice"
>>
>> https://cwiki.apache.org/confluence/label/SYNCOPE/practice
>>
>> and imagine if we define label for each version.
>>
>> WDYT?
>>
>>> On 13.02.2013 10:04, Francesco Chicchiriccò wrote:
>>>> On 13/02/2013 09:49, Christian Schneider wrote:
>>>>> Hi all,
>>>>>
>>>>> our current wiki pages for the minor releases only have names. While
>>>>> experienced syncope users may already know which version number this
>>>>> correlates to new users will have no clue.
>>>>>
>>>>> So I propose to add the version number to the names of the wiki pages
>>>>> like this:
>>>>>
>>>>> 0.5 - Crescendo
>>>>> 0.6 - Sostenuto
>>>>> 0.7 - Ritornello
>>>>> 1.0 - Espressivo
>>>>> 1.1 - Ad libitum
>>>>>
>>>>> What do you think?
>>>> I am not sure whether this is the best practice for handling versioned
>>>> content on wiki pages: how the other ASF projects deal with this?
>>>>
>>>> Regards.

-- 
Francesco Chicchiriccò

ASF Member, Apache Syncope PMC chair, Apache Cocoon PMC Member
http://people.apache.org/~ilgrosso/


Re: [Discuss] Adding a version number to the Wiki pages for releases

Posted by Christian Schneider <ch...@die-schneider.net>.
I think labels would not help a lot. Labels allow to mark several pages
to belong to the same theme. But we need just one page per version.

This is how camel does it:
http://camel.apache.org/download.html
http://camel.apache.org/camel-2103-release.html
http://camel.apache.org/camel-295-release.html

Basically I like the idea of one page per Version. In syncope we
currently have one page per Minor version and list all bugfix versions
inside the same page which is also ok.
So the only thing I am missing is the version number in the page title
and the url. This allows at camel to look at a url and instantly know
that it is about.

Chrisitian


On 13.02.2013 11:31, Francesco Chicchiriccò wrote:
> On 13/02/2013 10:41, Christian Schneider wrote:
>> I think the release pages are not really versioned content like code.
>> All pages are visible in parallel.
>
> Of course...
>
>> The name only makes it easier for users to see what each release is.
>
> Look at what Atlassian does for Confluence own documentation:
>
> https://confluence.atlassian.com/display/CONF35/Confluence+Documentation+Home
>
>
> https://confluence.atlassian.com/display/CONF40/Confluence+Documentation+Home
>
>
>
> This is definitely too much: what if we empower page labels for this?
> Take as example the label "practice"
>
> https://cwiki.apache.org/confluence/label/SYNCOPE/practice
>
> and imagine if we define label for each version.
>
> WDYT?
>
>> On 13.02.2013 10:04, Francesco Chicchiriccò wrote:
>>> On 13/02/2013 09:49, Christian Schneider wrote:
>>>> Hi all,
>>>>
>>>> our current wiki pages for the minor releases only have names. While
>>>> experienced syncope users may already know which version number this
>>>> correlates to new users will have no clue.
>>>>
>>>> So I propose to add the version number to the names of the wiki pages
>>>> like this:
>>>>
>>>> 0.5 - Crescendo
>>>> 0.6 - Sostenuto
>>>> 0.7 - Ritornello
>>>> 1.0 - Espressivo
>>>> 1.1 - Ad libitum
>>>>
>>>> What do you think?
>>> I am not sure whether this is the best practice for handling versioned
>>> content on wiki pages: how the other ASF projects deal with this?
>>>
>>> Regards.
>


-- 
Christian Schneider
http://www.liquid-reality.de

Open Source Architect
http://www.talend.com


Re: [Discuss] Adding a version number to the Wiki pages for releases

Posted by Francesco Chicchiriccò <il...@apache.org>.
On 13/02/2013 10:41, Christian Schneider wrote:
> I think the release pages are not really versioned content like code.
> All pages are visible in parallel.

Of course...

> The name only makes it easier for users to see what each release is.

Look at what Atlassian does for Confluence own documentation:

https://confluence.atlassian.com/display/CONF35/Confluence+Documentation+Home

https://confluence.atlassian.com/display/CONF40/Confluence+Documentation+Home


This is definitely too much: what if we empower page labels for this? 
Take as example the label "practice"

https://cwiki.apache.org/confluence/label/SYNCOPE/practice

and imagine if we define label for each version.

WDYT?

> On 13.02.2013 10:04, Francesco Chicchiriccò wrote:
>> On 13/02/2013 09:49, Christian Schneider wrote:
>>> Hi all,
>>>
>>> our current wiki pages for the minor releases only have names. While
>>> experienced syncope users may already know which version number this
>>> correlates to new users will have no clue.
>>>
>>> So I propose to add the version number to the names of the wiki pages
>>> like this:
>>>
>>> 0.5 - Crescendo
>>> 0.6 - Sostenuto
>>> 0.7 - Ritornello
>>> 1.0 - Espressivo
>>> 1.1 - Ad libitum
>>>
>>> What do you think?
>> I am not sure whether this is the best practice for handling versioned
>> content on wiki pages: how the other ASF projects deal with this?
>>
>> Regards.

-- 
Francesco Chicchiriccò

ASF Member, Apache Syncope PMC chair, Apache Cocoon PMC Member
http://people.apache.org/~ilgrosso/


Re: [Discuss] Adding a version number to the Wiki pages for releases

Posted by Christian Schneider <ch...@die-schneider.net>.
I think the release pages are not really versioned content like code.
All pages are visible in parallel.
The name only makes it easier for users to see what each release is.

Christian

On 13.02.2013 10:04, Francesco Chicchiriccò wrote:
> On 13/02/2013 09:49, Christian Schneider wrote:
>> Hi all,
>>
>> our current wiki pages for the minor releases only have names. While
>> experienced syncope users may already know which version number this
>> correlates to new users will have no clue.
>>
>> So I propose to add the version number to the names of the wiki pages
>> like this:
>>
>> 0.5 - Crescendo
>> 0.6 - Sostenuto
>> 0.7 - Ritornello
>> 1.0 - Espressivo
>> 1.1 - Ad libitum
>>
>> What do you think?
>
> I am not sure whether this is the best practice for handling versioned
> content on wiki pages: how the other ASF projects deal with this?
>
> Regards.
>


-- 
Christian Schneider
http://www.liquid-reality.de

Open Source Architect
http://www.talend.com


Re: [Discuss] Adding a version number to the Wiki pages for releases

Posted by Francesco Chicchiriccò <il...@apache.org>.
On 13/02/2013 09:49, Christian Schneider wrote:
> Hi all,
>
> our current wiki pages for the minor releases only have names. While
> experienced syncope users may already know which version number this
> correlates to new users will have no clue.
>
> So I propose to add the version number to the names of the wiki pages
> like this:
>
> 0.5 - Crescendo
> 0.6 - Sostenuto
> 0.7 - Ritornello
> 1.0 - Espressivo
> 1.1 - Ad libitum
>
> What do you think?

I am not sure whether this is the best practice for handling versioned 
content on wiki pages: how the other ASF projects deal with this?

Regards.

-- 
Francesco Chicchiriccò

ASF Member, Apache Syncope PMC chair, Apache Cocoon PMC Member
http://people.apache.org/~ilgrosso/