Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: [es] Create docs/contributing/style-guide.md #6134

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: [es] Create docs/contributing/style-guide.md #6134

wants to merge 8 commits into from
+123 −0

Conversation

didiViking
Copy link
Contributor

Related issue: #5205

@didiViking didiViking requested a review from a team as a code owner January 31, 2025 09:09
@opentelemetrybot opentelemetrybot requested review from a team and mx-psi and removed request for a team January 31, 2025 09:09
@opentelemetrybot opentelemetrybot requested a review from a team January 31, 2025 13:51
chalin
chalin requested changes Feb 2, 2025
View reviewed changes
content/en/docs/contributing/_index.md Outdated Show resolved Hide resolved
@opentelemetrybot opentelemetrybot requested review from a team February 2, 2025 17:36
@didiViking didiViking requested a review from chalin February 7, 2025 14:40
@didiViking
Copy link
Contributor Author

@krol3 All updated from my side, could you please review? TIA

chalin
chalin requested changes Feb 9, 2025
View reviewed changes
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@krol3 All updated from my side, could you please review? TIA

Right, I'll be waiting for @krol3 or any @open-telemetry/docs-es-approvers to approve before I do a final review.

In the meantime, please address the GitHub build check(s) that are failing. In particular from https://github.com/open-telemetry/opentelemetry.io/actions/runs/13228099793/job/36923430459?pr=6134 you'll see these link failures to be fixed:

es/docs/contributing/pr-checks/index.html
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#opentelemetryio-word-list
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#markdown-standards
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#spell-checking
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-format
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-names

@chalin
Copy link
Contributor

chalin commented Feb 9, 2025

/fix:dict

@opentelemetrybot
Copy link
Collaborator

You triggered fix:dict action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/13229022742

@opentelemetrybot
Copy link
Collaborator

fix:dict was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@opentelemetrybot opentelemetrybot requested review from a team February 10, 2025 08:48
@didiViking
Copy link
Contributor Author

@mx-psi Hi, could you please review the Spanish content? Many thanks.

mx-psi
mx-psi reviewed Feb 11, 2025
View reviewed changes
content/es/docs/contributing/style-guide.md Outdated
Comment on lines 13 to 14
- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)
- [Guía de estilo de documentación de Google Developer](https://developers.google.com/style)
- [Guía de estilo de documentación de Kubernetes](https://kubernetes.io/docs/contribute/style/style-guide/)
Suggested change
- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)
- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)

content/es/docs/contributing/style-guide.md Outdated
Comment on lines 16 to 18
Las siguientes secciones contienen orientación específica para el proyecto
OpenTelemetry.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Las siguientes secciones contienen orientación específica para el proyecto
OpenTelemetry.
Las siguientes secciones contienen indicaciones específicas para el proyecto
OpenTelemetry.
Suggested change
Las siguientes secciones contienen orientación específica para el proyecto
OpenTelemetry.
Las siguientes secciones contienen orientación específica para el proyecto
OpenTelemetry.

content/es/docs/contributing/style-guide.md Outdated
Comment on lines 21 to 22
Muchos de los requisitos de nuestra guía de estilo se pueden aplicar mediante la
ejecución de la automatización: antes de enviar un
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creo que se puede hacer de forma algo más simplificada

Suggested change
Muchos de los requisitos de nuestra guía de estilo se pueden aplicar mediante la
ejecución de la automatización: antes de enviar un
Muchos de los requisitos de nuestra guía de estilo se pueden aplicar automáticamente: antes de enviar un

content/es/docs/contributing/style-guide.md Outdated
[pull request](https://docs.github.com/en/get-started/learning-about-github/github-glossary#pull-request)
(PR), ejecute `npm run fix:all` en su máquina local y confirme los cambios.

Si se producen errores o [controles de PR fallidos](../pr-checks), lea nuestra
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creo que queda algo más idiomático así

Suggested change
Si se producen errores o [controles de PR fallidos](../pr-checks), lea nuestra
Si se producen errores o [fallan las comprobaciones de su PR](../pr-checks), lea nuestra

krol3
krol3 reviewed Feb 11, 2025
View reviewed changes
Copy link
Contributor

@krol3 krol3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for your contributions, here some comments

content/es/docs/contributing/style-guide.md Outdated
@@ -0,0 +1,122 @@
---
title: Guía de estilo de documentación
description: Terminología y estilo al escribir documentos de OpenTelemetry.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Terminología y estilo al escribir documentos de OpenTelemetry.
description: Terminología y estilo al escribir la documentación de OpenTelemetry.

content/es/docs/contributing/style-guide.md Outdated
---
title: Guía de estilo de documentación
description: Terminología y estilo al escribir documentos de OpenTelemetry.
linkTitle: Estilo de documentación
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
linkTitle: Estilo de documentación
linkTitle: Guía de estilo

content/es/docs/contributing/style-guide.md Outdated
Aún no tenemos una guía de estilo oficial, pero el estilo actual de la
documentación de OpenTelemetry está inspirado en las siguientes guías de estilo:

- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Guía de estilo de documentación para desarrolladores de Google](https://developers.google.com/style)

content/es/docs/contributing/style-guide.md Outdated
documentación de OpenTelemetry está inspirado en las siguientes guías de estilo:

- [Google Developer Guía de estilo de documentación](https://developers.google.com/style)
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/)
- [Guía de estilo de Kubernetes](https://kubernetes.io/docs/contribute/style/style-guide/)

content/es/docs/contributing/style-guide.md Outdated

{{% /alert %}}

## OpenTelemetry.io lista de palabras
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## OpenTelemetry.io lista de palabras
## Lista de palabras de OpenTelemetry.io

content/es/docs/contributing/style-guide.md Outdated
Ejecute `npm run fix:markdown` para corregir problemas de formato relacionados
con Markdown.

## Corrección ortográfica
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Corrección ortográfica
## Revisión ortográfica

@opentelemetrybot opentelemetrybot requested review from a team and mx-psi and removed request for a team February 12, 2025 14:39
@didiViking didiViking requested review from krol3 and chalin February 13, 2025 08:29
@didiViking
Copy link
Contributor Author

@chalin @mx-psi Regarding the links checks failing, I'm not sure how to fix these. I'm always running fix all before pushing the changes but I see this doesn't fix it. Also the main doc: https://opentelemetry.io/docs/contributing/localization/ is not super clear about it. If you have some clear instructions how to fix this, please let me. Thank you for your support :)

@mx-psi
Copy link
Member

mx-psi commented Feb 13, 2025

I am guessing these are the errors?

  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#opentelemetryio-word-list
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#markdown-standards
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#spell-checking
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-format
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-names

@didiViking
Copy link
Contributor Author

I am guessing these are the errors?

  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#opentelemetryio-word-list
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#markdown-standards
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#spell-checking
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-format
  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-names

Indeed.

didiViking and others added 8 commits February 13, 2025 18:22
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
c78f364 
Signed-off-by: Diana Todea <[email protected]>
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
361e09e 
Signed-off-by: Diana Todea <[email protected]>
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
d23fd1b 
Signed-off-by: Diana Todea <[email protected]>
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
425f830 
Signed-off-by: Diana Todea <[email protected]>
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
a2d9aa4 
Signed-off-by: Diana Todea <[email protected]>
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
b2b943d 
Signed-off-by: Diana Todea <[email protected]>
@opentelemetrybot @chalin
Results from /fix:dict
f205ae5
@didiViking @chalin
feat: [es] Create docs/contributing/style-guide.md
d676368 
Signed-off-by: Diana Todea <[email protected]>
@chalin
Copy link
Contributor

chalin commented Feb 13, 2025

Hi @didiViking. Let's consider this error:

  hash does not exist --- es/docs/contributing/pr-checks/index.html --> ../style-guide/#file-names

It says that the file in the PR doesn't have an heading ID named file-names, which is true. For guidance, see:

Some things are beyond the current capabilities of our fix commands. For example, our fix commands don't add heading IDs at the moment (though I'm thinking of doing so as soon as I can). I hope this helps clarify what is going on.

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

@mx-psi mx-psi Awaiting requested review from mx-psi mx-psi was automatically assigned from open-telemetry/docs-es-approvers

@krol3 krol3 Awaiting requested review from krol3

@chalin chalin Awaiting requested review from chalin

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
lang:es
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@didiViking @chalin @opentelemetrybot @mx-psi @krol3