Skip to content

Revise Apache Kafka description in README_pt.md - #1206

Merged
cevheri merged 2 commits into
libredb:mainfrom
ArthurRamonSouza:patch-1
Sep 30, 2026
Merged

cevheri merged 2 commits into
libredb:mainfrom
ArthurRamonSouza:patch-1

Conversation

@ArthurRamonSouza

Copy link
Copy Markdown
Contributor

Closes #1200

Updated Apache Kafka entry with improved wording and clarity.
@cevheri cevheri added the documentation Improvements or additions to documentation label Sep 29, 2026
@cevheri

cevheri commented Sep 29, 2026

Copy link
Copy Markdown
Member

Could anyone who is available take a look at this (second-review)
@paulocoutinhox
@Roberton003
@graffitiMSX
@kazinho213
@ikaroEngineer
@ArthurRamonSouza
@davismdosreis
@felixoakz
@chumborysonfjv
@biamp85

@cevheri cevheri added the help wanted Extra attention is needed label Sep 29, 2026
@paulocoutinhox

Copy link
Copy Markdown
Contributor

The Portuguese is already much more natural, but I would suggest a few small changes to preserve the exact technical meaning of the English source and make the wording more idiomatic in Brazilian Portuguese.

Main points:

  • valor enquadrado no formato Confluent sounds too literal; valor no formato Confluent is more natural.
  • configurações personalizadas changes the meaning of non-default configs; configurações não padrão is more accurate.
  • com poucas réplicas is not equivalent to under-replicated; com réplicas insuficientes is more precise.
  • brokers com suas respectivas configurações e saúde may imply that health specifically belongs to each broker, while the English sentence lists health, topic count, and disk size separately.
  • I would keep CA personalizada instead of AC personalizada, since CA is the commonly used technical term in TLS documentation.

Suggested final version:

| **Apache Kafka** | `@platformatic/kafka` (TypeScript puro, porta 9092) | Uma requisição de leitura em JSON que lê um tópico por partição, offset ou timestamp, a partir do offset mais antigo ou das mensagens mais recentes, com chaves, valores e cabeçalhos decodificados como JSON, texto ou base64, e um valor no formato Confluent rotulado com o ID do schema; explorador de tópicos com partições e configurações não padrão (um tópico offline ou com réplicas insuficientes é sinalizado), grupos de consumidores de ambos os protocolos com lag por partição, brokers com suas configurações, além de informações de saúde, quantidade de tópicos e tamanho em disco. Somente leitura por design: não produz mensagens, não faz commit de offsets, não participa de grupos e não cria tópicos. TLS com CA personalizada e certificados de cliente, e SASL PLAIN ou SCRAM somente sobre TLS; sem túnel SSH, porque os brokers são acessados pelos endereços que anunciam |

With these adjustments, I think the text reads naturally in Brazilian Portuguese while staying very close to the meaning of the English source.

Thanks guys.

Refine Apache Kafka section for clarity and consistency.
@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@cevheri
cevheri merged commit 2d5a273 into libredb:main Sep 30, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README_pt.md: rewrite the Apache Kafka row in natural Brazilian Portuguese

3 participants