Roundup Tracker - Issues

Issue 2550838

classification
Upgrading docs don't mention 1.5.0
Type: Severity: normal
Components: Documentation Versions: 1.5
process
Status: closed fixed
:
: : ber, jaraco, rouilj, schlatterbeck
Priority: :

Created on 2014-04-19 16:05 by jaraco, last changed 2016-07-15 02:05 by rouilj.

Messages
msg5084 Author: [hidden] (jaraco) Date: 2014-04-19 16:05
The PyPI page for roundup lists 1.5.0 and states that upgrading an
existing site _must_ follow the instructions in the
Maintenance/Upgrading page. Yet when one goes to that page, the title is
"Roundup 1.4 documentation" and there's no mention of how to upgrade to 1.5.

What is a user to do?
msg5085 Author: [hidden] (schlatterbeck) Date: 2014-04-22 14:59
On Sat, Apr 19, 2014 at 04:05:57PM +0000, Jason R. Coombs wrote:
> 
> The PyPI page for roundup lists 1.5.0 and states that upgrading an
> existing site _must_ follow the instructions in the
> Maintenance/Upgrading page. Yet when one goes to that page, the title is
> "Roundup 1.4 documentation" and there's no mention of how to upgrade to 1.5.
> 
> What is a user to do?

Thanks for the report, we probably should mention for which version of
the distribution the web-site is current.

Where did you find the title "Roundup 1.4 documentation"?
Neither http://roundup.sourceforge.net/docs.html nor
http://roundup.sourceforge.net/docs/upgrading.html explicitly mentions
1.4 ?

There were no necessary changes when upgrading from anything beyond
1.4.21 so there is no mention of 1.5.0.

The current copy of this website (or, better, the document the web site
is generated from) is in the 1.5.0 distribution in the directory doc and
is named 'upgrading.txt'. It is the same version as the website, so this
means there were no changes after 1.4.21 that require changes of a
running tracker.

Ralf
msg5117 Author: [hidden] (jaraco) Date: 2014-07-17 18:06
I forget how I got to the "Roundup 1.4 documentation".

I do see now that http://www.roundup-tracker.org/ currently states that
"The current stable version of Roundup is 1.4.x".

Also, if you follow the link to Docs in the left hand navigation, it
leads to http://www.roundup-tracker.org/docs.html for which the <title>
is "Docs - Roundup 1.4 documentation".

I guess when I saw that the documentation hadn't been upgraded to
mention 1.5, it seemed unlikely that I could trust the absence of an
upgrade message to mean no steps were necessary, so thanks for
clarifying that.

It would be worthwhile upgrading the docs to reflect the current
version, thereby providing some assurance that the non-mention of 1.5.0
in the upgrading docs is meaningful.
msg5118 Author: [hidden] (ber) Date: 2014-07-18 07:06
A new version of the website need to be uploaded to the www server.
And we should actually develop a mechanism to make sure that the 
version of upgrading information is shown.

Jason, thanks for pointing this out!
msg5659 Author: [hidden] (rouilj) Date: 2016-06-27 04:01
Docs at 1.5.1 and front page reports 1.5.x is current release.

Do we want to change that for every point release?

Is there anything we need to do here?
msg5854 Author: [hidden] (rouilj) Date: 2016-07-15 02:05
Updated the release docs with reference to exact urls that should be
updated.

Leaving directions on how to do that for future release
if it's not documented in website/README.txt.
History
Date User Action Args
2016-07-15 02:05:29rouiljsetstatus: new -> closed
resolution: remind -> fixed
messages: + msg5854
2016-06-27 04:01:53rouiljsetresolution: remind
messages: + msg5659
nosy: + rouilj
2014-07-18 07:06:29bersetmessages: + msg5118
2014-07-17 18:06:48jaracosetmessages: + msg5117
2014-04-23 10:11:41bersetnosy: + ber
2014-04-22 14:59:24schlatterbecksetnosy: + schlatterbeck
messages: + msg5085
2014-04-19 16:05:57jaracocreate