Guia com o passo a passo para começar a contribuir com o glossário CNCF em português
O projeto https://glossary.cncf.io/ é um glossário que busca explicar de forma clara e simples conceitos de cloud native sem exigir conhecimentos técnicos do público alvo.
O projeto é mantido em um repositório do github, onde os termos do glossários são escritos em Markdown (.md) e o site é construído usando Hugo.
É importante conhecimento prévio mínino de Git e GitHub para conseguir contribuir. Mas isso não é exclusivo, em caso de ajuda com os pré-requisitos, entrar em contato com @edsoncelio.
- Sempre opte por fazer um PR por definição, para facilitar o processo de revisão
- Sempre opte por criar uma branch para cada PR
- Procure manter seu fork sempre atualizado com o repositório original
- O nome do arquivo markdown (
.md) com a definição deve ser o mesmo do original (por ex: se traduziu o arquivodevops.mdpara o português, o nome do arquivo continua sendodevops.md) - Qualquer outra dúvida, pode perguntar no canal do time no slack da cncf (
#glossary-localization-portuguese) ou diretamente a alguma das pessoas revisoras (@edsoncelio, @brunoguidone ou @jessicalins)
O valor para o campo category (que fica no cabeçalho de todas as definições), deve ser traduzido para um dos seguintes:
| Termo | tradução |
|---|---|
| tecnology | tecnologia |
| concept | conceito |
| property | propriedade |
Para as definições da categoria conceito, a tradução dos subcabeçalhos deve ser da seguinte forma:
| Termo | tradução |
|---|---|
| What is it | O que é |
| Problem it addresses | Problema relacionado |
| How it helps | Como isso ajuda |
Alguns termos já possuem uma recomendação de tradução (qualquer sugestão de adição/atualização dos termos é aceita):
| Termo | tradução |
|---|---|
- (antes de tudo) Verifique as definições disponíveis para tradução nas issues do repositório e comente em qual vai trabalhar, assim, ela será atribuida a você
- Faça o fork do repositório: https://github.com/cncf/glossary e clone para sua máquina local
- Na sua máquina local, crie sua branch de trabalho a partir da branch
dev-pt - Selecione a definição que vai traduzir (localizar), os termos em português devem ficar em
content/pt-br - No processo de tradução, verifique os termos que já tem uma recomendação de tradução e não esqueça de traduzir o valor do campo
category - Se quiser validar sua tradução localmente, pode executar localmente seguindo essas instruções
- Ao finalizar sua tradução, abra um PR apontando para a branch de desenvolvimento de português (
dev-pt) e aguarde por revisão - (opcional) No canal do slack do time (
#glossary-localization-portuguese) avise que submeteu seu PR