Petr,

You got my vote on this:-). Your proposal makes good sense and will definitely solve a lot of misunderstandings.

----- Original Message ----- From: "Petr Kovar" pkovar@redhat.com To: docs@lists.fedoraproject.org, trans@lists.fedoraproject.org Sent: Monday, November 14, 2011 9:10:38 PM Subject: Proposal for a new process for publishing Fedora docs translations

Hi Fedora docs translators and writers,

After a discussion with shaiton following today's Fedora docs meeting, I propose to formalize the process of publishing Fedora docs translations.

BACKGROUND

Currently, we don't have in place a formal process for publishing docs translations. This means that we don't make it clear enough to our guide owners and translators what and when should be published.

PROPOSAL

The proposal is to create a new Bugzilla component and a group of default assignees for publishing translations to docs.fedoraproject.org.

The group is consisted of members of the docs-publishers group (and possibly also other people interested).

To get the translations published, Fedora translators are first required to file a bug against the proposed component. This applies to any translation of any document hosted on docs.fedoraproject.org. Then the members of the proposed group resolve the bug by publishing the requested translation.

RATIONALE

By using Bugzilla for the purposes of publishing translations, we can easily keep track of what translations the translators actually want to publish, at what time, and who is working with translators on publishing the translations.

This makes the whole publishing process much more transparent.

At the same time, we satisfy the demand from some of our community members to integrate the Bugzilla tool more deeply into our docs workflow.

To reduce a maintenance burden for individual docs owners, translators don't file a bug directly against the relevant guide component in the Fedora Documentation product.

REQUIREMENTS FOR TRANSLATORS

This requires each of the Fedora translation teams to have at least one member communicating with the proposed docs publishers group in Bugzilla.

However, translators don't have to learn new tools and rather complex processes specifically for Fedora docs, like working with Git, setting up an environment for syncing translations between Transifex.net and Git, or publishing to docs.fedoraproject.org with Publican.

NOTE

This proposal doesn't necessarily affect the translation teams that are already publishing their docs translations. They can continue with their existing workflow if it suits them and they have the manpower to do so. In other words, this proposed process is completely optional for them.

COMMENTS

Your comments, thoughts, or ideas are most welcome!

Thanks, Petr Kovar

Well done, Petr! I completely agree with others that this is an excellent proposal, and you of course have my full support.

On 11/14/2011 09:10 PM, Petr Kovar wrote:

Hi Fedora docs translators and writers,

After a discussion with shaiton following today's Fedora docs meeting, I propose to formalize the process of publishing Fedora docs translations.

BACKGROUND

Currently, we don't have in place a formal process for publishing docs translations. This means that we don't make it clear enough to our guide owners and translators what and when should be published.

PROPOSAL

The proposal is to create a new Bugzilla component and a group of default assignees for publishing translations to docs.fedoraproject.org.

The group is consisted of members of the docs-publishers group (and possibly also other people interested).

To get the translations published, Fedora translators are first required to file a bug against the proposed component. This applies to any translation of any document hosted on docs.fedoraproject.org. Then the members of the proposed group resolve the bug by publishing the requested translation.

RATIONALE

By using Bugzilla for the purposes of publishing translations, we can easily keep track of what translations the translators actually want to publish, at what time, and who is working with translators on publishing the translations.

This makes the whole publishing process much more transparent.

At the same time, we satisfy the demand from some of our community members to integrate the Bugzilla tool more deeply into our docs workflow.

To reduce a maintenance burden for individual docs owners, translators don't file a bug directly against the relevant guide component in the Fedora Documentation product.

REQUIREMENTS FOR TRANSLATORS

This requires each of the Fedora translation teams to have at least one member communicating with the proposed docs publishers group in Bugzilla.

However, translators don't have to learn new tools and rather complex processes specifically for Fedora docs, like working with Git, setting up an environment for syncing translations between Transifex.net and Git, or publishing to docs.fedoraproject.org with Publican.

NOTE

This proposal doesn't necessarily affect the translation teams that are already publishing their docs translations. They can continue with their existing workflow if it suits them and they have the manpower to do so. In other words, this proposed process is completely optional for them.

COMMENTS

Your comments, thoughts, or ideas are most welcome!

Thanks, Petr Kovar

----- Original Message ----- From: "Petr Kovar" pkovar@redhat.com To: docs@lists.fedoraproject.org; trans@lists.fedoraproject.org Sent: Monday, November 14, 2011 10:10 PM Subject: Proposal for a new process for publishing Fedora docs translations

| PROPOSAL | | The proposal is to create a new Bugzilla component and a group of | default assignees for publishing translations to docs.fedoraproject.org. | | The group is consisted of members of the docs-publishers group (and | possibly also other people interested). | | To get the translations published, Fedora translators are first required to | file a bug against the proposed component. This applies to any translation | of any document hosted on docs.fedoraproject.org. Then the members of the | proposed group resolve the bug by publishing the requested translation. |

Hi all!

My opinion is that the process must be automated like fpo main site. Manual publishing is slowly and unreliable: - changes in Release notes, made two weeks ago, are not published yet, even in English - I filed a bug against Burning Iso Images and Live Images. Still waiting. - There are previously translated in BG docs that I changed 3m2w ago, but changes does not applied.

I know, this may not be easy, but this is the way, I think.

Regards! Valentin Laskov

Hello,

On Mon, Nov 14, 2011 at 6:10 PM, Petr Kovar pkovar@redhat.com wrote:

Hi Fedora docs translators and writers,

After a discussion with shaiton following today's Fedora docs meeting, I propose to formalize the process of publishing Fedora docs translations.

BACKGROUND

Currently, we don't have in place a formal process for publishing docs translations. This means that we don't make it clear enough to our guide owners and translators what and when should be published.

PROPOSAL

The proposal is to create a new Bugzilla component and a group of default assignees for publishing translations to docs.fedoraproject.org.

The group is consisted of members of the docs-publishers group (and possibly also other people interested).

To get the translations published, Fedora translators are first required to file a bug against the proposed component. This applies to any translation of any document hosted on docs.fedoraproject.org. Then the members of the proposed group resolve the bug by publishing the requested translation.

RATIONALE

By using Bugzilla for the purposes of publishing translations, we can easily keep track of what translations the translators actually want to publish, at what time, and who is working with translators on publishing the translations.

This makes the whole publishing process much more transparent.

At the same time, we satisfy the demand from some of our community members to integrate the Bugzilla tool more deeply into our docs workflow.

To reduce a maintenance burden for individual docs owners, translators don't file a bug directly against the relevant guide component in the Fedora Documentation product.

REQUIREMENTS FOR TRANSLATORS

This requires each of the Fedora translation teams to have at least one member communicating with the proposed docs publishers group in Bugzilla.

However, translators don't have to learn new tools and rather complex processes specifically for Fedora docs, like working with Git, setting up an environment for syncing translations between Transifex.net and Git, or publishing to docs.fedoraproject.org with Publican.

NOTE

This proposal doesn't necessarily affect the translation teams that are already publishing their docs translations. They can continue with their existing workflow if it suits them and they have the manpower to do so. In other words, this proposed process is completely optional for them.

COMMENTS

Your comments, thoughts, or ideas are most welcome!

Your proposal is *not bad at all*, but I guess we should strongly consider an automated process for publishing docs too, as Valentin said.

This problem of deployment of docs is an issue that remains since I was an active member of the pt_BR team and used to work on Relnotes and TQSG several :) years ago. Once in a while manpower is a problem, so we can be safer (always updated) if we don't require much manual interventions/work.

The Websites team already does it. We should try to see what they have done and implement the 'same' procedures. AFAIK we would need to add just some extra steps because of Publican, but it shouldn't be a big deal. We just need to have a well written script.

The builds could run everyday and we could choose to publish only docs above a percentage of completion, if wanted. Errors on builds could be sent to people in a specific group, just like as the Website team does. This is the only case where a manual intervention would be required, but it should not happen too often. When whenever needed someone could just go and run a single command to publish a single doc.

Ex.: # all docs ./docs-publisher.py --minimum-perc 80

# release-notes docs ./docs-publisher.py release-notes --minimum-perc 80

# release-notes docs in pt-BR ./docs-publisher.py release-notes --minimum-perc 80 --lang pt-BR

BTW this sounds like I nice stuff to get done in the next FUDCon. :)

My 0.002 cents.

2011/11/22 Diego Búrigo Zacarão diegobz@gmail.com:

Your proposal is *not bad at all*, but I guess we should strongly consider an automated process for publishing docs too, as Valentin said.

Absolutely. I think an automated process would be the best as well, but until such time as someone steps up and writes the code to do it, we're going to have to do things manually. So, let's "not let perfect get in the way of good" here, and let's make the best of the manual process until such time as we have an automated process in place.

If you are willing to start writing code for the automated process, please let me know and we'll try to form a small working group to get it implemented.

-- Jared Smith Fedora Project Leader

Hi all,

On Wed, 23 Nov 2011 09:27:21 -0500 "Jared K. Smith" jsmith@fedoraproject.org wrote:

2011/11/22 Diego Búrigo Zacarão diegobz@gmail.com:

...

Your proposal is *not bad at all*, but I guess we should strongly consider an automated process for publishing docs too, as Valentin said.

Absolutely. I think an automated process would be the best as well, but until such time as someone steps up and writes the code to do it, we're going to have to do things manually. So, let's "not let perfect get in the way of good" here, and let's make the best of the manual process until such time as we have an automated process in place.

If you are willing to start writing code for the automated process, please let me know and we'll try to form a small working group to get it implemented.

First, thank you all guys for your valuable feedback.

As far as the automated process for publishing is concerned, I absolutely agree with Jared.

We can always move to a better solution, but for now, let's focus on something that can work for us from the start.

Cheers, Petr Kovar