Manual de estilo da documentação
O conteúdo desta página pode estar desatualizado e alguns links podem ser
inválidos.
Uma versão mais recente desta página existe em
Inglês. Para visualizar as alterações na página em inglês desde a última atualização: visite
GitHub compare 5ab64067..4aa05a4d
e procure por Mais informações ...
content/en/docs/contributing/style-guide.md.
Ainda não possuímos um manual de estilo oficial, porém, a atual aparência da documentação do OpenTelemetry é influenciada pelos seguintes manuais de estilo:
As seções a seguir contêm orientações específicas para o projeto OpenTelemetry.
Muitos requisitos do nosso manual de estilo podem ser aplicados
automaticamente: antes de enviar uma pull request (PR), execute
npm run fix:all na sua máquina local e faça o commit das alterações.
Se você encontrar erros ou falhas nas verificações de PR, leia sobre nosso manual de estilo e aprenda o que pode ser feito para corrigir certos problemas comuns.
Lista de palavras do OpenTelemetry.io
Uma lista de termos e palavras específicas do OpenTelemetry que devem ser usadas de forma consistente em todo o site:
Para uma lista completa de termos do OpenTelemetry e suas definições, consulte o Glossário.
Certifique-se de que nomes próprios, como outros projetos da CNCF ou ferramentas
de terceiros, sejam escritos corretamente e utilizem a capitalização original.
Por exemplo, escreva “PostgreSQL” em vez de “postgre”. Para uma lista completa,
verifique o arquivo
.textlintrc.yml.
Markdown
As páginas do site são escritas na sintaxe Markdown suportada pelo renderizador Markdown Goldmark. Para a lista completa de extensões Markdown suportadas, consulte Goldmark.
Você também pode utilizar as seguintes extensões:
- Alertas do GitHub-flavored Markdown (GFM)
- Emojis. Para a lista completa de emojis disponíveis, consulte os Emojis da documentação do Hugo.