Skip to content

Instantly share code, notes, and snippets.

@edsoncelio

edsoncelio/traducao_docs_otel_pt_br.md

Last active August 8, 2024 18:27
Show Gist options
  • Save edsoncelio/ebaf3172bdca6134eb4caec16dad09dd to your computer and use it in GitHub Desktop.
Save edsoncelio/ebaf3172bdca6134eb4caec16dad09dd to your computer and use it in GitHub Desktop.
Download ZIP
Passo a Passo para Tradução das docs do OpenTelemetry para Português
Raw
traducao_docs_otel_pt_br.md

Informações Gerais

  • Toda a comunicação acontece no canal (aberto) #otel-localization-ptbr no slack da CNCF.
  • As documentações (docs) são escritas em Markdown,
  • Para ver o preview da sua tradução, pode abrir o PR como rascunho (draft) que vai ser gerado um preview via Netlify,

Passo a Passo

1. Faça o fork do repositório da documentação

O repositório da documentação do projeto é o open-telemetry/opentelemetry.io

2. Faça o pull para sua máquina local do seu fork

3. Crie uma branch a partir da branch main

4. Faça a localização na branch que criou

Alguns pontos importantes:

  • cada tradução é baseado em um commit das docs original, então obrigatóriamente deve ter um campo chamado default_lang_commit contendo a hash do commit da doc original, por exemplo:
title: OpenTelemetry
description: >-
 Telemetria de alta qualidade, abrangente e portátil para permitir uma observabilidade eficaz
developer_note:
  O shortcode blocks/cover (usado abaixo) vai servir como imagem de background
  para qualquer arquivo de imagem que contenha "background" no nome.
show_banner: true
default_lang_commit: 08799298

Para uma página nova, você precisa executar o seguinte comando para buscar a hash do commit:

npm run fix:i18n:new

Mais detalhes você pode consultar aqui.

  • Se atente a termos que já possuem um glossário, assim mantemos consistência entre as docs, pode checar aqui a lista

5. Faça o lint da sua tradução

Para garantir que o seu PR vai passar nos checks do repositório, faça o lint do arquivo com o comando abaixo (usando docker):

docker run -it  --rm -v$(pwd):/app -w /app  --entrypoint "" node:latest npx prettier --write .

6. Abra o PR para a branch main

Sugerimos que use um título começando com [pt], assim mantemos consistência, por exemplo:

[pt-br] Localize index page to Portuguese (Brazil)

7. Envie o PR no canal #otel-localization-ptbr no slack da CNCF.

8. Aguarde as interações para revisão, é esperado que tenha bastante, não se assuste :)

@EzzioMoreira
Copy link

@edsoncelio adiciona o link do rascunho do glossário:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment