Bug links in translated version of documents should direct to openstack-i18n

Bug #1277544 reported by Łukasz Jernaś on 2014-02-07
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack i18n
Wishlist
KATO Tomoyuki
openstack-manuals
Wishlist
KATO Tomoyuki

Bug Description

Links to the bug tracker on the docs site should direct to the i18n project's project (openstack-i18n) on Launchpad, as some bugs may be related only to translations. Also translators can easier forward other issues to openstack-manuals if they need that.

This will require a change in clouddocs-maven-plugin, maybe a build time option ?

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Wishlist
Łukasz Jernaś (deejay1) wrote :

Andreas do you have any hints were I should start looking to handle this? I know the line I have to change is https://github.com/stackforge/clouddocs-maven-plugin/blob/master/src/main/resources/common/main-openstack.js#L212 but I can't seem to find any reference to that file in the repo

Andreas Jaeger (jaegerandi) wrote :

David is the expert here - not me.

David Cramer (david-thingbag) wrote :

main-openstack.js is renamed to main.js when moved to the output directory (assuming branding=openstack). I gather you want to change the line:

 var urlBase = "https://bugs.launchpad.net/openstack-manuals/+filebug?field.title="

Such that we're making "openstack-manuals" configurable (so that if the language is not en_US the urlBase points to "openstack-i18n)?

Let me know if that's correct and I'll give a little more guidance.

Łukasz Jernaś (deejay1) wrote :

Yes, that's correct

David Cramer (david-thingbag) wrote :

Pondering this: one way would be to add some js that looks at the url for a language code in a certain place and changes openstack-manuals to openstack-i18n if it's there. That feels brittle though. We could also modify that value at build-time based on the language used to build the doc. I suspect that's the better approach.

I would modify the logABug function so that it takes a third "component" param. Then in the xslts where we write out the html that inserts the call to logABug we pass in that param, picking one depending on whether we're building an en doc or not.

Tom Fifield (fifieldt) on 2014-12-24
Changed in openstack-manuals:
status: Confirmed → Triaged
Tom Fifield (fifieldt) on 2015-06-12
Changed in openstack-i18n:
status: New → Confirmed
Changed in openstack-manuals:
assignee: nobody → KATO Tomoyuki (kato-tomoyuki)
Changed in openstack-i18n:
assignee: nobody → KATO Tomoyuki (kato-tomoyuki)
importance: Undecided → Wishlist

Fix proposed to branch: master
Review: https://review.openstack.org/257003

Changed in openstack-manuals:
status: Triaged → In Progress
Changed in openstack-i18n:
status: Confirmed → In Progress

Reviewed: https://review.openstack.org/257003
Committed: https://git.openstack.org/cgit/openstack/openstack-doc-tools/commit/?id=6f4a9758b5432a59eddf1771fef84fca9357a052
Submitter: Jenkins
Branch: master

commit 6f4a9758b5432a59eddf1771fef84fca9357a052
Author: KATO Tomoyuki <email address hidden>
Date: Sun Dec 13 14:46:32 2015 +0900

    Set the bug project to i18n for the translated docs

    Change-Id: Ia86334649990a09c02a379c10adae55594a68c1d
    Closes-Bug: #1277544

Changed in openstack-manuals:
status: In Progress → Fix Released
Changed in openstack-i18n:
status: In Progress → Fix Committed

This issue was fixed in the openstack/openstack-doc-tools 0.33.0 release.

Changed in openstack-i18n:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers