<font face="arial,helvetica,sans-serif">Hello,<br></font><br><div class="gmail_quote">On Mon, Nov 14, 2011 at 6:10 PM, Petr Kovar <span dir="ltr"><<a href="mailto:pkovar@redhat.com">pkovar@redhat.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">Hi Fedora docs translators and writers,<br>
<br>
After a discussion with shaiton following today's Fedora docs meeting, I<br>
propose to formalize the process of publishing Fedora docs translations.<br>
<br>
BACKGROUND<br>
<br>
Currently, we don't have in place a formal process for publishing docs<br>
translations. This means that we don't make it clear enough to our guide<br>
owners and translators what and when should be published.<br>
<br>
PROPOSAL<br>
<br>
The proposal is to create a new Bugzilla component and a group of<br>
default assignees for publishing translations to <a href="http://docs.fedoraproject.org" target="_blank">docs.fedoraproject.org</a>.<br>
<br>
The group is consisted of members of the docs-publishers group (and<br>
possibly also other people interested).<br>
<br>
To get the translations published, Fedora translators are first required to<br>
file a bug against the proposed component. This applies to any translation<br>
of any document hosted on <a href="http://docs.fedoraproject.org" target="_blank">docs.fedoraproject.org</a>. Then the members of the<br>
proposed group resolve the bug by publishing the requested translation.<br>
<br>
RATIONALE<br>
<br>
By using Bugzilla for the purposes of publishing translations, we can<br>
easily keep track of what translations the translators actually want to<br>
publish, at what time, and who is working with translators on publishing the<br>
translations.<br>
<br>
This makes the whole publishing process much more transparent.<br>
<br>
At the same time, we satisfy the demand from some of our community members<br>
to integrate the Bugzilla tool more deeply into our docs workflow.<br>
<br>
To reduce a maintenance burden for individual docs owners, translators don't<br>
file a bug directly against the relevant guide component in the Fedora<br>
Documentation product.<br>
<br>
REQUIREMENTS FOR TRANSLATORS<br>
<br>
This requires each of the Fedora translation teams to have at least one<br>
member communicating with the proposed docs publishers group in Bugzilla.<br>
<br>
However, translators don't have to learn new tools and rather complex<br>
processes specifically for Fedora docs, like working with Git, setting up an<br>
environment for syncing translations between Transifex.net and Git, or<br>
publishing to <a href="http://docs.fedoraproject.org" target="_blank">docs.fedoraproject.org</a> with Publican.<br>
<br>
NOTE<br>
<br>
This proposal doesn't necessarily affect the translation teams that<br>
are already publishing their docs translations. They can continue with<br>
their existing workflow if it suits them and they have the manpower to do<br>
so. In other words, this proposed process is completely optional for them.<br>
<br>
COMMENTS<br>
<br>
Your comments, thoughts, or ideas are most welcome!<br>
<br></blockquote></div><br><br>Your proposal is *not bad at all*, but I guess we should strongly <br>consider an automated process for publishing docs too, as Valentin<br>said.<br><br>This problem of deployment of docs is an issue that remains since I was<br>
an active member of the pt_BR team and used to work on Relnotes and<br>TQSG several :) years ago. Once in a while manpower is a problem, so<br>we can be safer (always updated) if we don't require much manual <br>interventions/work.<br>
<br>The Websites team already does it. We should try to see what they have<br>done and implement the 'same' procedures. AFAIK we would need to add<br>just some extra steps because of Publican, but it shouldn't be a big deal. <br>
We just need to have a well written script.<br><br>The builds could run everyday and we could choose to publish only docs<br>above a percentage of completion, if wanted. Errors on builds could be <br>sent to people in a specific group, just like as the Website team does. This<br>
is the only case where a manual intervention would be required, but it should<br>not happen too often. When whenever needed someone could just go and<br>run a single command to publish a single doc.<br><br>Ex.: <br>
# all docs<br>
./docs-publisher.py --minimum-perc 80 <br>
<br>
# release-notes docs<br>
./docs-publisher.py release-notes --minimum-perc 80<br>
<br>
# release-notes docs in pt-BR<br>
./docs-publisher.py release-notes --minimum-perc 80 --lang pt-BR<br><br><br>BTW this sounds like I nice stuff to get done in the next FUDCon. :)<br><br>My 0.002 cents.<br><br>-- <br>Diego Búrigo Zacarão<br><a href="http://diegobz.net">http://diegobz.net</a> <br>