Defensive and secure coding guide: call for renaming files

[Petr Bokoc]

Hi,

On 08/26/2013 03:56 AM, Dimitris Glezos wrote:
> <snip>
>
> * The Fedora Install guide at the moment has close to 1000 files. I
> can tell you, it is arguably the ugliest project on Transifex. :-)
>    https://fedora.transifex.com/projects/p/fedora-install-guide/resources/
The Fedora Install Guide is not being translated in Transifex anymore; 
it has been moved to Zanata and the Transifex files are not updated for 
Fedora 19. The Zanata instance has "only" 759 files :). Yes, it's still 
ugly, I'm working on that.

https://translate.zanata.org/zanata/project/view/fedora-installation-guide

I understand that it might seem unusual and even counter-productive to 
split translation projects between two separate systems, with this guide 
being the only one being translated elsewhere. See this e-mail in the 
list archive from the guide's previous maintainer explaining the reasons 
behind the decision: 
https://lists.fedoraproject.org/pipermail/docs/2013-April/014951.html.

Your e-mail pointed out something that I feel should be addressed 
though. There seems to be some confusion at this point about the 
Transifex instance. Is there a way to somehow mark it as obsolete, make 
it read-only or just hide or even delete it? It doesn't seem like a good 
decision to keep the guide in Transifex and having unsuspecting 
translators possibly waste their time working on an obsolete project.
> On Sun, Aug 25, 2013 at 12:43 PM, Christopher Antila
> <crantila at fedoraproject.org> wrote:
>> Hello:
>>
>> On 08/25/2013 04:04 AM, Jérôme Fenal wrote:
>>> Hi all,
>>>
>>> The Defensive and coding guide sports an interesting and forgotten
>>> feature in its file organization: directories.
>>> Beyond directories, it also happens to show files having the same name
>>> (such as Language.xml, found in Python/, Java/, CXX/, C/, etc. or
>>> schema.xml).
>>>
>>> You tell me, that is what directories are for. Fair enough.
>>>
>>> The real issue here is that pushing .po resulting from those XML files
>>> to Transifex which only handles uniquely named resources in a flat
>>> hierarchy leads to a mess, where there is no predictibility in having
>>> the Language resource always the same on Transifex, depending how those
>>> are pushed.
>>>
>>> Could it be possible to rename all those files to unique names, ideally
>>> with the subdir as a prefix (such as CXX-Language.xml or C-schema.xml)
>>> so that we have unique resource names in Transifex?
>>>
>>> Furthermore, could we add a requirement to documentation authors in
>>> order to ensure that all XML files in their document hierarchy show
>>> unique names?
>> This is an interesting problem that the guide's author probably didn't
>> think of! I'm definitely in favour of renaming these files as a
>> short-term solution. I suggest that the best long-term solution is to
>> add a directory-like feature to Transifex. After all, if authors think a
>> hierarchic information strategy is useful, then translators would
>> probably also think it's useful.
>>
>> Another issue: according to the bug Jérôme opened, it looks like Florian
>> Weimer is the guide owner, but I don't see it in the guides table.[0] So
>> what's going on here?
>>
>> Either way, I'd be happy to help rename files, unless anybody objects.
>>
>>
>> Christopher
>>
>> [0] https://fedoraproject.org/wiki/Docs_Project_guides_table
>>
>> --
>> docs mailing list
>> docs at lists.fedoraproject.org
>> To unsubscribe:
>> https://admin.fedoraproject.org/mailman/listinfo/docs
>
>
-- 
Petr Bokoc (irc: pbokoc)
Technical Writer
Engineering Content Services

Red Hat Czech, s. r. o.
Purkynova 99
612 45 Brno, Czech Republic