Roundup Tracker - Issues

Issue 2550496

classification
documentation link under 'Help' now broken
Type: behavior Severity: minor
Components: Web interface Versions: 1.4
process
Status: closed fixed
:
: stefan : richard, stefan, tonimueller
Priority: :

Created on 2009-02-05 16:58 by tonimueller, last changed 2009-06-17 15:08 by stefan.

Messages
msg3507 Author: [hidden] (tonimueller) Date: 2009-02-05 16:58
After roundup getting a new homepage, the help link in the menu is now
broken. See Debian's BTS #514215.

diff -urNad roundup-1.4.4~/templates/classic/html/page.html
roundup-1.4.4/templates/classic/html/page.html
--- roundup-1.4.4~/templates/classic/html/page.html     2008-03-01
09:06:42.000000000 +0100
+++ roundup-1.4.4/templates/classic/html/page.html      2009-02-05
17:15:34.000000000 +0100
@@ -164,7 +164,7 @@
   </p>
   <p class="userblock">
    <b i18n:translate="">Help</b><br>
-   <a href="http://roundup.sourceforge.net/doc-1.0/"
+   <a href="http://www.roundup-tracker.org/docs.html"
     i18n:translate="">Roundup docs</a>
   </p>
  </td>
diff -urNad roundup-1.4.4~/templates/minimal/html/page.html
roundup-1.4.4/templates/minimal/html/page.html
--- roundup-1.4.4~/templates/minimal/html/page.html     2008-03-01
09:08:05.000000000 +0100
+++ roundup-1.4.4/templates/minimal/html/page.html      2009-02-05
17:15:28.000000000 +0100
@@ -151,7 +151,7 @@
   </p>
   <p class="userblock">
    <b i18n:translate="">Help</b><br>
-   <a href="http://roundup.sourceforge.net/doc-1.0/"
+   <a href="http://www.roundup-tracker.org/docs.html"
     i18n:translate="">Roundup docs</a>
   </p>
  </td>
msg3509 Author: [hidden] (stefan) Date: 2009-02-05 17:59
Thanks for spotting this. Your patch would certainly work, however I
wonder whether it wouldn't be better to actually install the docs as
part of the roundup package, and then, fixing these links to point to
local documentation instead of the Roundup website.
Richard, what do you think ?
msg3510 Author: [hidden] (tonimueller) Date: 2009-02-05 18:17
Hi Stefan,

On Thu, 05.02.2009 at 17:59:08 +0000, Stefan Seefeld <issues@roundup-tracker.org> wrote:
> Stefan Seefeld <stefan@codesourcery.com> added the comment:

> Thanks for spotting this. Your patch would certainly work, however I

I'd like to note that most of my bug reports are not my own creation,
but things that hit my mailbox in the course of maintaining Debian's
roundup package. So, if you want to thank someone for originally
finding, and/or solving, the problem, you usually need to go to the
Debian bug reports that I link to.

> wonder whether it wouldn't be better to actually install the docs as
> part of the roundup package, and then, fixing these links to point to
> local documentation instead of the Roundup website.

I don't currently augment the package with docs that are not contained
in the package. So, only the contained man pages get shipped with the
package. Although I also see value in having local docs, linking to the
project's web page is a good idea, imho, at least now that the project
has a wiki, too.

Kind regards,
--Toni++
msg3511 Author: [hidden] (stefan) Date: 2009-02-05 18:34
Toni Mueller wrote:

> I'd like to note that most of my bug reports are not my own creation,
> but things that hit my mailbox in the course of maintaining Debian's
> roundup package. So, if you want to thank someone for originally
> finding, and/or solving, the problem, you usually need to go to the
> Debian bug reports that I link to.

I see. May I suggest we introduce a convention that allows a) the 
tracker to generate appropriate links into the upstream tracker and b) 
makes casual readers immediately aware of where the link goes ?
May be a syntax such as 'debian#514215' in this case ?

>> wonder whether it wouldn't be better to actually install the docs as
>> part of the roundup package, and then, fixing these links to point to
>> local documentation instead of the Roundup website.
> 
> I don't currently augment the package with docs that are not contained
> in the package. So, only the contained man pages get shipped with the
> package. Although I also see value in having local docs, linking to the
> project's web page is a good idea, imho, at least now that the project
> has a wiki, too.

OK. Yes, I was thinking of packaging docs that right now are generated 
but not installed / packaged.

Thanks,
          Stefan
msg3512 Author: [hidden] (tonimueller) Date: 2009-02-05 18:49
Hi,

On Thu, 05.02.2009 at 18:34:39 +0000, Stefan Seefeld <issues@roundup-tracker.org> wrote:
> I see. May I suggest we introduce a convention that allows a) the 
> tracker to generate appropriate links into the upstream tracker

huh? Debian's BTS already has appropriate links when I link to
Roundup's tracker. See eg. this bug report:

http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=514221

At the end of it, you can read:

"Noted your statement that Bug has been forwarded to
http://issues.roundup-tracker.org/issue2550497."

I'm also a bit confused because you *are* upstream. Debian is
downstream.

For the other direction:

> makes casual readers immediately aware of where the link goes ?
> May be a syntax such as 'debian#514215' in this case ?

This would be great, however. I'd also like to be able to just click on
the number and get to the respective bug report in the BTS. While you
are at it, please make this part of Roundup's standard distribution.
:-)

> OK. Yes, I was thinking of packaging docs that right now are generated 
> but not installed / packaged.

If someone would like to roll an official package, I'd package these,
too.

Kind regards,
--Toni++
msg3513 Author: [hidden] (stefan) Date: 2009-02-05 19:20
Toni Mueller wrote:
> Toni Mueller <dev@tonimueller.org> added the comment:
> 
> Hi,
> 
> On Thu, 05.02.2009 at 18:34:39 +0000, Stefan Seefeld <issues@roundup-tracker.org> wrote:
>> I see. May I suggest we introduce a convention that allows a) the 
>> tracker to generate appropriate links into the upstream tracker
> 
> huh? Debian's BTS already has appropriate links when I link to
> Roundup's tracker. See eg. this bug report:

Sorry for being misleading. What I meant was a convention here on this 
tracker to use debian#514221 to refer to the upstream bug. I have just 
added the necessary logic to the tracker to make this string be 
translated into an appropriate link when looked at via the web interface.

Thanks,
		Stefan
msg3514 Author: [hidden] (richard) Date: 2009-02-05 21:24
I would prefer to move the docs in the website back to the old location
so that all installed tracker links work, old mailing list discussions
are still valid and search engine searches still work.
msg3515 Author: [hidden] (stefan) Date: 2009-02-05 21:30
Richard Jones wrote:
> Richard Jones <richard@mechanicalcat.net> added the comment:
> 
> I would prefer to move the docs in the website back to the old location
> so that all installed tracker links work, old mailing list discussions
> are still valid and search engine searches still work.

OK. I agree it makes sense not to break compatibility without a good 
reason. I'm not sure though what exactly needs to be done, as I don't 
know under what name(s) / URLs documentation has been referred to.
Toni's example was http://roundup.sourceforge.net/doc-1.0/, which could 
be solved either by a local link, or an URL rewrite.
What other URLs need to be kept alive ?

Thanks,
		Stefan
msg3516 Author: [hidden] (richard) Date: 2009-02-05 21:40
On Fri, 6 Feb 2009, Stefan Seefeld wrote:
> OK. I agree it makes sense not to break compatibility without a good
> reason. I'm not sure though what exactly needs to be done, as I don't
> know under what name(s) / URLs documentation has been referred to.
> Toni's example was http://roundup.sourceforge.net/doc-1.0/, which could
> be solved either by a local link, or an URL rewrite.

This seems reasonable.

> What other URLs need to be kept alive ?

None, though we lost the "user feedback" page along the way, which is a shame.
msg3517 Author: [hidden] (tonimueller) Date: 2009-02-06 08:54
Hi,

On Thu, 05.02.2009 at 21:30:37 +0000, Stefan Seefeld <issues@roundup-tracker.org> wrote:
> Richard Jones wrote:
> > I would prefer to move the docs in the website back to the old location
> > so that all installed tracker links work, old mailing list discussions
> > are still valid and search engine searches still work.
> OK. I agree it makes sense not to break compatibility without a good 
> reason. I'm not sure though what exactly needs to be done, as I don't 
> know under what name(s) / URLs documentation has been referred to.

my guess is, that unless you can access SF's access logs, there is no
good way finding out which links broke.

> Toni's example was http://roundup.sourceforge.net/doc-1.0/, which could 

This link is hard-coded in the 'page.html' templates. I am also in
favour of not breaking backwards compatibility ("cool URLs never
change"), and would suggest either of the following:

> be solved either by a local link, or an URL rewrite.

If this turns out to be infeasible, I'd say that it would be good to
put up a placeholder page, also set as a 404 error document, that says
something like "The project has moved to a new website. Please click
.... to go to the new website.", or similar.

Kind regards,
--Toni++
msg3535 Author: [hidden] (richard) Date: 2009-02-12 01:58
The /doc-1.0/ URL works again but it's got the old website content
rather than the new.
msg3539 Author: [hidden] (stefan) Date: 2009-02-12 05:10
Richard Jones wrote:
> Richard Jones <richard@mechanicalcat.net> added the comment:
> 
> The /doc-1.0/ URL works again but it's got the old website content
> rather than the new.

Yup, that was a Quick Hack, until I could figure out how to do it right.
I'll look into this soon, I promise.

Thanks,
	Stefan
msg3542 Author: [hidden] (tonimueller) Date: 2009-02-12 08:33
Hi,

On Thu, 12.02.2009 at 05:10:11 +0000, Stefan Seefeld <issues@roundup-tracker.org> wrote:
> Richard Jones wrote:
> > The /doc-1.0/ URL works again but it's got the old website content
> > rather than the new.
> Yup, that was a Quick Hack, until I could figure out how to do it right.

unless you can implement an automatic redirect, putting up a
placeholder page that says "moved, go to the new location" would be a
sure way to direct people to the new docs.

Kind regards,
--Toni++
msg3730 Author: [hidden] (stefan) Date: 2009-06-17 15:08
I changed the 'Help' URL to point to 'http://www.roundup-tracker.org' as
per rev:4227.
History
Date User Action Args
2009-06-17 15:08:24stefansetstatus: new -> closed
assignee: stefan
resolution: fixed
messages: + msg3730
2009-02-12 08:33:16tonimuellersetmessages: + msg3542
2009-02-12 05:10:11stefansetmessages: + msg3539
2009-02-12 01:58:12richardsetmessages: + msg3535
2009-02-06 08:54:26tonimuellersetmessages: + msg3517
2009-02-05 21:40:54richardsetmessages: + msg3516
2009-02-05 21:30:37stefansetmessages: + msg3515
2009-02-05 21:24:43richardsetmessages: + msg3514
2009-02-05 19:20:52stefansetmessages: + msg3513
2009-02-05 18:49:20tonimuellersetmessages: + msg3512
2009-02-05 18:34:39stefansetmessages: + msg3511
2009-02-05 18:17:07tonimuellersetmessages: + msg3510
2009-02-05 17:59:08stefansetnosy: + stefan, richard
messages: + msg3509
2009-02-05 16:59:00tonimuellercreate