Bug link broken for first-app

Bug #1461185 reported by Andreas Jaeger
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Bernd Bausch

Bug Description

If I report a bug for the FirstApp pages, I get something like below:

-----------------------------------
Release: 0.1 on 2015-06-02 06:41
SHA: ab13ff1cf02fb9f6191868f7cab369b2cf79e35b
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/treee/getting_started.rst

this is wrong: It should be api-site instead of openstack-manuals and also not treee but tree/first-app/....

tags: added: doc-builds
tags: added: openstackdocstheme
Revision history for this message
The-Kid (speer-emett) wrote :

can you please provide us with steps to reproduce this issue.

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → liberty
importance: Undecided → Medium
status: New → Confirmed
importance: Medium → High
Scott Adkins (adkinss)
Changed in openstack-manuals:
assignee: nobody → Scott Adkins (adkinss)
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

The code for most of this is in openstackdocstheme

Revision history for this message
Scott Adkins (adkinss) wrote :

Thanks, Andreas... I will look in openstackdocstheme!

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Scott, any progress on this?

Revision history for this message
Bernd Bausch (berndbausch) wrote :

The path is hardcoded "http://git.openstack.org/cgit/openstack/openstack-manuals/tree" in the file script_footer.html. At the time the code was written, the assumption was that the theme would only be used for manuals under .../openstack-manuals/doc.

The third "e" in "treee" is probably related to the fact that there is no "doc" in the pathnames of firstapp sources, or there is a "doc" at an unexpected place in the pathname.

Shouldn't be too hard to fix. I hope Scott agrees that I assign the bug to myself.

Changed in openstack-manuals:
assignee: Scott Adkins (adkinss) → Bernd Bausch (berndbausch)
Revision history for this message
Scott Adkins (adkinss) wrote : Re: [Bug 1461185] Re: Bug link broken for first-app

Have at it! I don't want to be a roadblock and have been thus far...
Appreciate that somebody else is taking it.

Thanks!
Scott

On Fri, Oct 2, 2015 at 11:36 AM, Bernd Bausch <email address hidden> wrote:

> The path is hardcoded "
> http://git.openstack.org/cgit/openstack/openstack-manuals/tree" in the
> file script_footer.html. At the time the code was written, the assumption
> was that the theme would only be used for manuals under
> .../openstack-manuals/doc.
>
> The third "e" in "treee" is probably related to the fact that there is
> no "doc" in the pathnames of firstapp sources, or there is a "doc" at an
> unexpected place in the pathname.
>
> Shouldn't be too hard to fix. I hope Scott agrees that I assign the bug
> to myself.
>
>
> ** Changed in: openstack-manuals
> Assignee: Scott Adkins (adkinss) => Bernd Bausch (berndbausch)
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1461185
>
> Title:
> Bug link broken for first-app
>
> Status in openstack-manuals:
> Confirmed
>
> Bug description:
> If I report a bug for the FirstApp pages, I get something like below:
>
> -----------------------------------
> Release: 0.1 on 2015-06-02 06:41
> SHA: ab13ff1cf02fb9f6191868f7cab369b2cf79e35b
> Source:
> http://git.openstack.org/cgit/openstack/openstack-manuals/treee/getting_started.rst
>
> this is wrong: It should be api-site instead of openstack-manuals and
> also not treee but tree/first-app/....
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1461185/+subscriptions
>

Revision history for this message
Bernd Bausch (berndbausch) wrote :

Here is a difficulty.

Firstapp source pathname on build server: pathname1/api-site/firstapp/source
Manual source pathname on build server: pathname1/openstack-manuals/doc/pathname2

Firstapp git URL: http://git.openstack.org/cgit/openstack/api-site/tree/firstapp/source/
Manuals git URL: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/pathname2

To build the correct git URL, I need to insert the string "tree" between "api-site" and "firstapp", or between "openstack-manuals" and "doc". To do this automatically for both cases, I need to know the value of pathname1 (the code would just splice the full pathname after the component that follows pathname1).

So here is the question to people in the know, such as Andreas:
**Is the value of pathname1 guaranteed to be always the same? And what is it?**

If it is not always the same, I currently don't see how I can insert "tree" at the right place, except by hard-coding the above build server pathname fragments. This would only cover the two cases Manuals and Firstapp (and would be as inelegant as the current code).

Revision history for this message
Bernd Bausch (berndbausch) wrote :

Scott, it's now merged.

No, you weren't a roadblock. I took this bug over immediately after I found it.

Cheers,

Bernd

-----Original Message-----
From: <email address hidden> [mailto:<email address hidden>] On Behalf Of Scott Adkins
Sent: Saturday, October 03, 2015 2:12 AM
To: <email address hidden>
Subject: Re: [Bug 1461185] Re: Bug link broken for first-app

Have at it! I don't want to be a roadblock and have been thus far...
Appreciate that somebody else is taking it.

Thanks!
Scott

On Fri, Oct 2, 2015 at 11:36 AM, Bernd Bausch <email address hidden>
wrote:

> The path is hardcoded "
> http://git.openstack.org/cgit/openstack/openstack-manuals/tree" in the
> file script_footer.html. At the time the code was written, the
> assumption was that the theme would only be used for manuals under
> .../openstack-manuals/doc.
>
> The third "e" in "treee" is probably related to the fact that there is
> no "doc" in the pathnames of firstapp sources, or there is a "doc" at
> an unexpected place in the pathname.
>
> Shouldn't be too hard to fix. I hope Scott agrees that I assign the
> bug to myself.
>
>
> ** Changed in: openstack-manuals
> Assignee: Scott Adkins (adkinss) => Bernd Bausch (berndbausch)
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1461185
>
> Title:
> Bug link broken for first-app
>
> Status in openstack-manuals:
> Confirmed
>
> Bug description:
> If I report a bug for the FirstApp pages, I get something like below:
>
> -----------------------------------
> Release: 0.1 on 2015-06-02 06:41
> SHA: ab13ff1cf02fb9f6191868f7cab369b2cf79e35b
> Source:
> http://git.openstack.org/cgit/openstack/openstack-manuals/treee/gettin
> g_started.rst
>
> this is wrong: It should be api-site instead of openstack-manuals and
> also not treee but tree/first-app/....
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/openstack-manuals/+bug/1461185/+subscriptio
> ns
>

--
You received this bug notification because you are a bug assignee.
https://bugs.launchpad.net/bugs/1461185

Title:
  Bug link broken for first-app

Status in openstack-manuals:
  Confirmed

Bug description:
  If I report a bug for the FirstApp pages, I get something like below:

  -----------------------------------
  Release: 0.1 on 2015-06-02 06:41
  SHA: ab13ff1cf02fb9f6191868f7cab369b2cf79e35b
  Source: http://git.openstack.org/cgit/openstack/openstack-manuals/treee/getting_started.rst

  this is wrong: It should be api-site instead of openstack-manuals and
  also not treee but tree/first-app/....

To manage notifications about this bug go to:
https://bugs.launchpad.net/openstack-manuals/+bug/1461185/+subscriptions

Revision history for this message
Njira Perci (njirap) wrote :

Hi Bernd.. If its merged I'll just go ahead and mark it as such..

Changed in openstack-manuals:
status: Confirmed → Fix Committed
Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.