Bug 1232996 - [RFE] Include title in document name uploaded from Drupal plugin
Summary: [RFE] Include title in document name uploaded from Drupal plugin
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Zanata
Classification: Retired
Component: Usability, DrupalPlugin
Version: unspecified
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: ---
Assignee: David Mason
QA Contact: Zanata-QA Mailling List
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-06-18 02:22 UTC by David Mason
Modified: 2015-07-08 00:49 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: 0.5
Clone Of:
Environment:
Last Closed: 2015-07-08 00:49:43 UTC
Embargoed:


Attachments (Terms of Use)

Description David Mason 2015-06-18 02:22:56 UTC
At the moment, documents in Zanata from Drupal use the node id only as the name, so translators do not have much information to tell what each document is. The names are like:

 - node/10001
 - node/11025

Usually the "title" field from Drupal is the first row to translate in the file.


To allow translators to tell more easily what each document is, the title could be included in the name, so the names might look more like this:

 - node/10001/Print UTF-8 encoded text file using lpr in Red Hat Enterprise Linux 5
 - node/11025/How do I get a new Red Hat Satellite certificate?


Note: this change would break existing translation jobs because the translations would be against the old document name. Copy Translations (with appropriate settings) could be run by maintainers to apply any existing translations to the new document name.


Technical notes:

 - For any characters that are not allowed in a filename in Zanata, a character like - or _ could be substituted.
 - Length of filename and full path are limited in Zanata. The Drupal plugin should truncate the title if it would not fit within these constraints.

Comment 1 Michelle Kim 2015-06-19 02:02:09 UTC
Hi David,

This is exactly one of the thing came into my mind during the demo. Thanks for creating this RFE and I believe this is quite a high priority given the value it will provide once the drupal plugin pushes file to Zanata, it will be almost a must for translator to be able to view the file name instead of node number.

I will set this priority high and lets discuss the story points.

Comment 2 David Mason 2015-06-19 02:41:54 UTC
> I will set this priority high and lets discuss the story points.

I have set this to 0.5 story points - it is a very easy change, it would take longer to discuss story points than to just implement it. I should have time to make this change today.

Comment 3 Luke Brooker 2015-06-19 03:03:59 UTC
When I was explaining this I was actually thinking that it would be two separate things:

The document name:
"How do I get a new Red Hat Satellite certificate?"

The path:
"node/11025/"

This would also mean that the path could be used to access the content.

e.g. http://access.redhat.com/node/11025/

Does that make sense?

Comment 4 Michelle Kim 2015-06-19 03:37:00 UTC
Is the node name created by our Drupal Plug-in or is it the name from the customer portal link? 

if it's arbitrary number that is created by our Drupal Plug-In, would the node point to the document content like e.g. http://access.redhat.com/node/11025/ or will it be different on actual published content link?

Comment 5 Luke Brooker 2015-06-19 03:45:50 UTC
(In reply to Michelle Kim from comment #4)

It's the actual node ID from customer portal/drupal. And all drupal nodes can be accessed from node/<node ID>, even if the article has a clean url.

e.g. The link above actually works, but the link Drupal stores to link to this page within Drupal is actually https://access.redhat.com/solutions/11025.

Comment 6 Michelle Kim 2015-06-19 03:55:41 UTC
(In reply to Luke Brooker from comment #5)

> e.g. The link above actually works, but the link Drupal stores to link to
> this page within Drupal is actually
> https://access.redhat.com/solutions/11025.

Thanks Luke. Now it makes sense to me. 

So the naming would be to help translators to understand the content of the articles but also it would be good to have the path used to access the content.

Comment 7 Luke Brooker 2015-06-19 03:57:50 UTC
(In reply to Michelle Kim from comment #6)

Yes, exactly.

Comment 8 David Mason 2015-06-19 08:51:35 UTC
> When I was explaining this I was actually thinking that it would be two separate things:
> 
> The document name:
> "How do I get a new Red Hat Satellite certificate?"
> 
> The path:
> "node/11025/"

Zanata automatically splits the name and path at the last '/' character, so it will be stored this way in Zanata even though it is sent as one field by the plugin.

I will have to replace any '/' in the name with a different character so that it does not get cut up incorrectly.

What it will actually show in the current UI is the title as the name of the document, and the path (like "/node/11025") underneath it in smaller fainter text. Translators would be able to copy just the path from underneath and add it after the customer portal URL to see the original document on the site.

Comment 9 David Mason 2015-06-23 00:56:49 UTC
Updated in https://github.com/zanata/tmgmt_zanata/pull/4

Comment 10 Damian Jansen 2015-07-07 00:25:27 UTC
Verified (tmgmt_zanata) at 71ebdf3dc7bb13889356d9c579eb55d08a5a518a


Note You need to log in before you can comment on or make changes to this bug.