documentation « /webdev

Interessado(a) em contribuir com a tradução da documentação oficial do Symfony2? Seja bem-vindo(a)!

Este post traz as orientações de como proceder e como estamos nos organizando para a tradução dos documentos. A seguinte thread da lista de discussões sobre o symfony tem as informações iniciais, conforme as instruções da página oficial.

No ano passado, traduzimos o livro “Mais com o symfony 1.3 & 1.4” que foi publicado e está a venda na Amazon.

Então, vamos lá! 🙂

Informando os documentos que deseja traduzir

Para melhor organização, primeiro informar o(s) documento(s) que pretende ajudar na tradução e/ou revisão na planilha de tradutores/revisores.

Se ainda não possuir acesso de edição nesta planilha, solicitar acesso para andreiabohner at gmail dot com.

Utilizando o Git e o github

Agora, para nos auxiliar, temos a nossa disposição o github, uma ferramenta fantástica, onde encontra-se a documentação.
Abaixo está uma descrição sucinta de como utilizar o git e o github.

Para começar, fazer o fork do repositório master da tradução para o português no github:

Acessar o repositório master no github
Clicar no botão fork:

Agora, você irá “clonar” o projeto para a sua máquina local:
Copiar a URL do repositório do seu fork (semelhante a imagem abaixo), para utilizá-la com o comando git clone:

$ git clone git@github.com:seuusername/symfony-docs-pt-BR.git

Após completar o clone do repositório, ele terá o nome remoto “origin“. Não confundir, apesar do nome ser origin ele não está apontando para o repo master, mas sim para o seu fork no github.

Pronto, agora é só trabalhar na tradução do(s) documento(s).

Finalizadas as traduções e/ou revisões, faça o commit das alterações no seu repositório local:
$ git commit –a –m "pt_BR translation"

E atualize o seu repositório no servidor github com as alterações realizadas localmente:
$ git push origin master

O último passo é informar sobre as suas alterações ao responsável pelo repositório de origem para que ele faça um pull das alterações no repositório. Para isso, acesse a página do repositório original no github, em: https://github.com/andreia/symfony-docs-pt-BR e envie um pull request (clicando no botão “Pull Request”):

Mantendo seu repositório local atualizado

Sempre antes de fazer as suas alterações locais, lembrar de executar o comando pull para manter atualizado o seu repositório local trazendo as alterações do repositório de origem (o repositório que você fez o fork):
$ git remote add upstream git://github.com/andreia/symfony-docs-pt-BR.git
$ git pull upstream master

Formato da documentação

A documentação do Symfony2 utiliza a linguagem markup reStructuredText juntamente com o Sphinx, ao invés do markdown. Segue a referência: http://symfony.com/doc/2.0/contributing/documentation/format.html
Se preferir, existe um editor online, que pode auxiliar em: http://rst.ninjs.org/