https://github.com/edsoncelio/otel-localization-ptbr-guide
https://github.com/edsoncelio/otel-localization-ptbr-guide
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/edsoncelio/otel-localization-ptbr-guide
- Owner: edsoncelio
- License: gpl-3.0
- Created: 2024-08-16T23:16:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T11:34:08.000Z (over 1 year ago)
- Last Synced: 2025-06-16T17:11:13.749Z (about 1 year ago)
- Homepage: https://edsoncelio.dev/otel-localization-ptbr-guide/
- Size: 52.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Olá, aqui você vai encontrar todas (ou quase todas) as informações para começar
a contribuir com a localização da documentação do OpenTelemetry para Português!
## Sobre a documentação do OpenTelemetry
* Link para a documentação: [https://opentelemetry.io/pt/docs/](https://opentelemetry.io/pt/docs/).
* Link para o repositório da documentação: [https://github.com/open-telemetry/opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io)
* As documentações são escritas em [Markdown](https://www.markdownguide.org/basic-syntax/).
## Sobre o time de localização (Português)
* Toda a comunicação acontece no canal `#otel-localization-ptbr` no workspace da CNCF no slack, então antes de tudo, entre no canal!!
* Se você ainda não estiver entrado no workspace, pode solicitar um convite [aqui](https://communityinviter.com/apps/cloud-native/cncf)
* Temos encontros quinzenais via Zoom (quarta-feira, 19:17-19:45 BRT), detalhes da agenda e pauta, pode encontrar [aqui](https://docs.google.com/document/d/1W1jJ4OTm53sbOp7CrbNBMvR_2Z8TQRCkwejqD4f21SE/edit).
## Páginas prioritárias para tradução/localização
A princípio, estamos priorizando algumas páginas para tradução, sendo que:
* As páginas que estão [nessa issue](https://github.com/open-telemetry/opentelemetry.io/issues/4922) e ainda não tem uma pessoa atribuida são as prioritárias
* Após todas as páginas da issue acima estarem finalizadas, a prioridade são as páginas de linguagens (`https://opentelemetry.io/pt/docs/languages/`), focando em Go, Javascript, Java e .NET.
## Detalhes importantes
Alguns detalhes importantes que você deve conferir antes de abrir seu *Pull Request*.
* 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:
```md
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:
```bash
docker run -it --rm -v$(pwd):/app -w /app --entrypoint "" node:latest npm run fix:i18n:new
```
Mais detalhes você pode consultar [aqui](https://opentelemetry.io/docs/contributing/localization/#track-changes).
* Se atente a termos que já possuem um glossário, assim mantemos consistência entre as docs, pode checar [aqui](https://opentelemetry.io/docs/contributing/style-guide/#opentelemetryio-word-list) a lista
* Caso tenha dúvidas sobre a tradução de um termo, verifique o glossário que time vem desenvolvendo [aqui](https://docs.google.com/document/d/1kyu6HgdsM3-iDyf3OuRmfw4SwNJy9BVui6nn5JsKb5I/edit?tab=t.0#heading=h.o389kqcsmupl)
* Para garantir que a validação dos links na página funcione corretamente, precisamos manter as âncoras (_anchors_) sem tradução.
Temos uma action do Github que verifica os links da página, caso esteja quebrado gera avisos de `Warnings` no build, exemplo de âncora:
```md
Título: ## O que é Observabilidade? {#what-is-observability}
Título: ## Trechos {#span}
Título: ## Rastros {#traces}
```
* Se o cabeçalho conter um campo `redirects:`, remova.
## Passo a Passo
Após estar familiarizado com o processo de contribuição, siga o passo a passo abaixo para fazer sua primeira contribuição.
1. Pesquise se já existe uma issue aberta para a documentação que quer localizar (pode usar [esse](https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aopen+is%3Aissue+label%3Alang%3Apt) filtro de busca), se já existir uma issue e alguém trabalhando, procure outra página.
2. Caso não exista issue aberta para a página que quer localizar, pode criar uma, seguindo o padrão de título: `[pt] localization `
3. Faça o fork do repositório da documentação: `https://github.com/open-telemetry/opentelemetry.io`
4. Faça o clone do seu fork para sua máquina local, exemplo:
```bash
git clone git@github.com:edsoncelio/opentelemetry.io.git
```
5. Crie uma branch a partir da branch `main` para fazer sua tradução, exemplo:
```bash
git checkout -b adiciona_traducao_traces
```
6. Com a branch criada, faça toda a sua tradução, sempre lembrando de fazer o push para o seu fork remoto, exemplo:
```bash
git add .
git commit -m "docs: adiciona traducao de traces"
git push origin adiciona_traducao_traces
```
7. Sempre antes de abrir um *Pull Request*, execute o *lint*, assim não vai quebrar nas checagens automáticas:
```bash
docker run -it --rm -v$(pwd):/app -w /app --entrypoint "" node:latest npx prettier --write .
```
8. Quando finalizar, ou apenas quiser solicitar uma revisão, abre o *Pull Request* para a branch main.
Para essa etapa, sugerimos que use o prefixo `[pt]`no título, assim mantemos consistência, por exemplo:
```bash
[pt] Localize content/pt/docs/concepts/components.md
```
9. Envie o PR no canal do slack `#otel-localization-ptbr`.
10. Aguarde as interações para revisão, é esperado que tenha bastante, não se assuste :)
## ID ausente no Commit
O problema é que o autor dos commits não está vinculado à conta do usuário no GitHub e isso é necessário para que o EasyCLA identifique o usuário e conceda autorização.
Geralmente ajustar as configurações globais do GitHub resolve o problema.
```sh
git commit --amend --author="FirstName LastName " --no-edit
git push --force
```
### Caso Contrário faça rebase do commit:
Primeiro identifique qual commit você precisa ajustar.
```sh
git rebase -i ^
```
Isso abrirá um editor, mude o comando `pick` para `edit` no commit que deseja corrigir:
```sh
pick feat: mensagem de exemplo do commit
```
Salve e feche o editor.
Agora, atualize o autor do commit com o comando abaixo, substituindo pelo nome e e-mail corretos:
```sh
git commit --amend --author="FirstName LastName " --no-edit
```
Depois de corrigir o commit, continue o processo de rebase:
```sh
git rebase --continue
```
Como o histórico foi alterado, será necessário forçar o push para o repositório remoto:
```sh
git push --force
```
## Perguntas Frequentes
TBD