Introdução ao Projeto

O projeto brasileiro de documentação do FreeBSD é mantido por membros do Grupo Brasileiro de Usuários FreeBSD e tem por objetivo traduzir para a língua portuguesa (pt_BR) os documentos publicados inglês pelo FreeBSD Documentation Project (FDP).

O workflow atual de tradução se baseia na tradução de arquivos de texto simples construídos com a ajuda do gettext, os quais contém as frases que formam os documentos.

A tradução dos arquivos pode ser realizada através de qualquer editor de textos, mas recomendamos o uso da plataforma online Zanata.

Os arquivos traduzidos encontram-se versionados em um repositório no GitHub, e mantemos um processo de build automático baseado em Jenkins para gerar os documentos periodicamente para que os tradutores possam acompanhar o resultado final, sem que tenham que instalar todo o ambiente do docproj em suas maquinas pessoais.

Uma vez traduzidos e revisados, os arquivos são enviados ao repositório de SVN que hospeda a documentação oficial do projeto FreeBSD.

Como faço para contribuir com o projeto?

Para contribuir com o projeto basta criar uma conta na plataforma online utilizada pelo projeto, chamada Zanata.

Para criar a sua conta basta vistar a URL abaixo:

https://translate.zanata.org/account/register

Ao acessar a URL você irá visualizar um formulário bem simples, mostrado abaixo:

Você deverá preencher os campos do formulário com as seguintes informações:

  • Seu nome completo
  • Nome de usuário desejado
  • Seu email
  • Uma senha segura – escolha uma senha única para o Zanata, não reutilize uma senha que você já usa em outros lugares.

Para enviar o seu cadastro basta clicar em “Inscrição” (botão azul).

Assim que receber o seu cadastro o sistema do Zanata irá lhe enviar um email contendo um link que você deverá clicar para ativar a sua conta. Observe que o link enviado é valido por apenas 24 horas.

Depois que tiver ativado a sua conta na plataforma, por favor envie o seu nome de usuário por email para ebrandi ou dbaio em FreeBSD.org. Assim que recebermos sua mensagem iremos lhe dar permissão para acessar os arquivos que estamos traduzindo.

Assim que receber a confirmação de que seu acesso foi liberado no projeto, você já poderá iniciar suas contribuições.

Para isso vc precisará visitar a url abaixo:

https://translate.zanata.org/iteration/view/FreeBSD/head/languages/pt-BR

e se logar clicando no botão “log in” que existe no menu lateral esquerdo do site,  mostrado na figura abaixo:

Ao logar no sistema você irá visualizar no lado direito da sua tela a lista de documentos disponíveis para tradução, como mostrado abaixo:

Você pode trabalhar em qualquer documento que esteja com um percentual de tradução abaixo de 100%. Para abrir o documento para iniciar sua tradução basta clicar no arquivo desejado, como por exemplo no explaining-bsd. Ao abrir o arquivo você irá ver a tela abaixo:

A tela pode parecer confusa a primeira vista, mas na verdade é bem simples de usar 🙂

A tela é dividida em 2 colunas, a coluna do lado esquerdo contem as strings no idioma original (no nosso caso em en_US), a coluna da direita é a coluna que contem o texto traduzido (no nosso caso em pt_BR).

O Zanata irá lhe mostrar um bloco de texto para cada parágrafo existente no documento original, você deverá traduzir o texto e manter as TAGs existentes idênticas as exibidas no bloco da esquerda.

Se o bloco que você traduziu estiver OK, a aparência dele será semelhante a abaixo:

Para salvar a sua tradução basta clicar em outro bloco. A indicação de que o bloco traduzido está sendo salvo pelo Zanata é a  mensagem “Saving” que é exibida no canto esquerdo superior do bloco em que vc estava trabalhando, como mostrado na figura abaixo:

Caso você faça algo diferente de traduzir as strings de texto o sistema irá lhe mostrar um alerta na parte inferior do bloco. Você deverá corrigir o erro antes de prosseguir com a tradução.

Alguns dos erros mais comuns são:

Se você adicionou uma linha extra no inicio ou no final do paragrafo, você verá o seguinte erro:

Linha extra no inicio do paragrafo
Linha extra no inicio do paragrafo
Linha extra no final do paragrafo
Linha extra no final do paragrafo

Se você esqueceu alguma das tags existentes no bloco original, você verá o seguinte erro:

missing tag
missing tag

Se você adicionou uma tag que não exista no bloco original, você verá o seguinte erro:

unexpected tags
unexpected tags

Se você cometeu mais de um erro, o sistema irá mostrar todos os erros aplicáveis em uma única mensagem de alerta:

Bloco traduzido com vários erros
Bloco traduzido com vários erros

Por dividir um documento em diversos blocos o Zanata suporta edição simultânea de um mesmo documento, logo é possível que em algum momento exista algum outro voluntário esteja trabalhando no mesmo documento que você.

Caso aconteça de duas pessoas editarem o mesmo bloco de texto ao mesmo tempo, a plataforma irá persistir a versão que for salva por ultimo, de forma que na pratica um tradutor pode apagar o trabalho do outro. De forma que você deve evitar sempre que possível trabalhar em um bloco de texto que já esteja sendo traduzido por outra pessoa.

Felizmente o Zanata nos mostra quando tem alguma outra pessoa trabalhando no mesmo bloco de texto, quando isso ocorrer ele irá exibir o nome do outro tradutor no canto superior esquerdo do bloco que está sendo traduzido, como mostrado na figura abaixo:

Observe que a cor da notificação é muito sutil, logo fique atento!

Pronto, você já sabe como enviar suas contribuições! O processo é tão simples quanto editar um bloco de texto por meio de uma pagina web 😉

Como vejo o resultado final das minhas contribuições?

O Projeto Doc-BR utiliza um pipeline automatizado para compilação automática da documentação baseado na ferramenta Jenkins.

Sempre que ele perceber que foi efetuado um novo commit no repositório do projeto no github o Jenkins irá compilar a documentação, sendo que independente de ter ocorrido ou não uma atualização no repositório, o Jenkins irá buscar os arquivos .po traduzidos diretamente na plataforma do Zanata e compilar a documentação traduzida diariamente as 07:00 BRT.

O objetivo deste pipeline é permitir que nossos voluntários possam visualizar como está ficando o documento que está sendo traduzido, antes mesmo da tradução estar finalizada.

Os documentos compilados pelo Jenkins ficam disponíveis na url abaixo:

https://doc.fug.com.br/jenkins/

Nesta fase inicial do projeto os documentos traduzidos ainda não estão incorporados ao repositório SVN do FreeBSD Docproj. Os arquivos serão adicionados ao repositório nas próximas semanas.

Como me comunico com os demais membros do projeto?

O principal canal de comunicação entre os membros do projeto é a lista de discussão Doc-BR, mantida no servidor da FUG.

Para se cadastrar ou obter maiores informações visite a página da lista disponível na URL:

http://www.fug.com.br/mailman/listinfo/doc

Você também pode se comunicar com os membros do projeto através do IRC (sim esse serviço ainda existe!).  Muitos dos nossos membros frequentam o canal ##freebsd-br na rede Freenode.

Caso você não tenha um cliente de IRC instalado, você pode utilizar o client web disponivel na URL:

https://webchat.freenode.net

Para aqueles que preferem uma comunicação mais em tempo real, também temos um um grupo de discussão no App Telegram, caso tenha interesse de participar do grupo basta visitar a URL abaixo e clicar no botão “Join Group”:

https://goo.gl/ajCJjv

Por hora era isso, muito obrigado pelo interesse em contribuir com o Projeto FreeBSD Doc-BR.

Abs

FreeBSD Doc-BR Team