[Openstack-docs] Track .tx in git or not?

Akihiro Motoki amotoki at gmail.com
Wed Mar 12 10:37:57 UTC 2014


Hi,

I have one thoing I would like to mention.

Having .tx/config file in openstack-manuals repository is useful for
translators who
generate translated version of documents. If we remove .tx/config from
the repository,
such translators needs to check the transifex repository and create
.tx/config manually.
It is not convenient. We can have .tx/config in the documentation I18N page, but
it requires some additional steps every time to prepare new git clone.
The merit to have .tx/config in the repo helps us keep .tx/config up-to-date and
we can share it. Translators can maintain .tx/config privately but
there is no place to share it.

Though transifex configruation file .tx/config is not related and I understand
such translators is very limited, it is worth considered.
Even if we can get the command line example from openstack-infra/config,
it doesn't make sense because transifex config and jenkins script are
not related.

I don't have a strong opinion on it, but I don't feel it comfortable.
If it is remove, I will just fork openstack-manuals repository to have
.tx/config
and sync it with the upstream by cron.

Thanks,
Akihiro


On Wed, Mar 12, 2014 at 4:21 PM, Andreas Jaeger <aj at suse.com> wrote:
> On 03/12/2014 04:35 AM, Ying Chun Guo wrote:
>> Hello,
>>
>> The folder .tx is used to save the configuration of Transifex Client,
>> which supports our translation process.
>> The folder .tx in openstack-manuals is in managed by git index and
>> tracked changes by git.
>> The file .tx/config saves the mapping information between local po files
>> and the resources in Transifex.
>> If a new po file is added, the file .tx/config will be changed.
>>
>> Now the changes of folder .tx will cause a failure of the job
>> propose_translation_update_manuals.
>> I'm going to fix it.
>
> Thanks for fixing this for good, Daisy!
>
>> Both of below two ways work:
>> removing .tx from git tree and index, or changing
>> propose_translation_update_manuals.sh to track changes in .tx.
>> I just don't know which one is the better choice.
>>
>> Removing .tx from git because: .tx has no relationship with
>> openstack-manuals.
>> The scripts propose_translation_update_manuals.sh and
>> upstream_translation_update_manuals.sh can use command lines
>> to create and edit the configurations.
>>
>> Tracking .tx in git because: when some people want to use Transifex
>> Client to manage po files, with .tx, they can
>> use simple Transifex Client command line to pull the translations, and
>> don't need to understand the complex mapping
>> information.
>>
>> There is no consensus in OpenStack projects. Some projects don't track
>> and some projects track.
>> I think we need a consensus at least within all documentation projects.
>> I prefer the first opinion - removing .tx from git
>> Please let me know your thoughts to this question.
>
> I'm fine with removing .tx from git. Thanks for your patch for that -
> this needs changes in config as well, please review my patch
> https://review.openstack.org/79866
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



More information about the Openstack-docs mailing list