From 7bbacc538841ff3e32f47590732b75dd161049c9 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Fri, 31 Jan 2025 09:46:29 +0100 Subject: [PATCH 01/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/_index.md | 2 +- content/es/docs/contributing/style-guide.md | 121 ++++++++++++++++++++ 2 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 content/es/docs/contributing/style-guide.md diff --git a/content/es/docs/contributing/_index.md b/content/es/docs/contributing/_index.md index c9c32dc312b1..064b6122d7c3 100644 --- a/content/es/docs/contributing/_index.md +++ b/content/es/docs/contributing/_index.md @@ -2,7 +2,7 @@ title: Contribuir description: Aprende cómo contribuir a la documentación de OpenTelemetry. weight: 980 -default_lang_commit: 30783526402b69a3ac44eeb0f6cf066732f0bdca +default_lang_commit: 4c5ca8e5b0876832ced6c1b57f8099f796794462 --- Quienes colaboran para documentar OpenTelemetry: diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md new file mode 100644 index 000000000000..43da7cb4eb03 --- /dev/null +++ b/content/es/docs/contributing/style-guide.md @@ -0,0 +1,121 @@ +--- +title: Guía de estilo de documentación +description: Terminología y estilo al escribir documentos de OpenTelemetry. +linkTitle: Estilo de documentación +weight: 20 +cSpell:ignore: open-telemetry postgre style-guide textlintrc +--- + +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) +- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/) + +Las siguientes secciones contienen orientación específica para el proyecto +OpenTelemetry. + +{{% alert title="Note" color="primary" %}} + +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 +[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 +guía de estilo y aprenda qué puede hacer para solucionar ciertos asuntos +comunes. + +{{% /alert %}} + +## OpenTelemetry.io lista de palabras + +Una lista de términos y palabras específicos de OpenTelemetry que se deben usar +de manera uniforme en todo el sitio: + +- [OpenTelemetry](/docs/concepts/glossary/#opentelemetry) y + [OTel](/docs/concepts/glossary/#otel) +- [Collector](/docs/concepts/glossary/#collector) +- [OTEP](/docs/concepts/glossary/#otep) +- [OpAMP](/docs/concepts/glossary/#opamp) + +Para obtener una lista completa de los términos de OpenTelemetry y su +definición, consulte [Glosario](/docs/concepts/glossary/). + +Asegúrese de que los nombres propios, como otros proyectos de CNCF o +herramientas de terceros, estén escritos correctamente y utilicen la mayúscula +original. Por ejemplo, escriba "PostgreSQL" en lugar de "postgre". Para obtener +una lista completa, consulte el archivo +[`.textlintrc.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.textlintrc.yml). + +{{% alert title="Tip" %}} + +Ejecute `npm run check:text` para verificar que todos los términos y palabras +estén escritos correctamente. + +Ejecute `npm run check:text -- --fix` para corregir términos y palabras que no +están escritos correctamente. + +{{% /alert %}} + +## Estándares de Markdown + +Para hacer cumplir los estándares y la coherencia de los archivos Markdown, +todos los archivos deben seguir ciertas reglas, impuestas por +[markdownlint](https://github.com/DavidAnson/markdownlint). Para obtener una +lista completa, consulte el archivo +[`.markdownlint.json`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.markdownlint.json). + +Ejecute `npm run check:markdown` para verificar que todos los archivos siguen el +estándar. + +Ejecute `npm run fix:markdown` para corregir problemas de formato relacionados +con Markdown. + +## Corrección ortográfica + +Utilice [CSpell](https://github.com/streetsidesoftware/cspell) para asegurarse +de que todo su texto esté escrito correctamente. Para obtener una lista de +palabras específicas del sitio web OpenTelemetry, consulte el archivo +[`.cspell.yml`](https://github.com/open-telemetry/opentelemetry.io/blob/main/.cspell.yml). + +Ejecute `npm run check:spelling` para verificar que todas las palabras estén +escritas correctamente. Si `cspell` indica un error de `Palabra desconocida`, +verifique si escribió esa palabra correctamente. Si es así, agregue esta palabra +a la sección `cSpell:ignore` en la parte superior de su archivo. Si no existe +dicha sección, puede agregarla al principio de un archivo Markdown: + +```markdown +--- +título: TítuloDeLaPágina +cSpell:ignore: +--- +``` + +Para cualquier otro archivo, agregue `cSpell:ignore ` en una línea de +comentario apropiada para el contexto del archivo. Para un archivo YAML de +entrada [registry](/ecosystem/registry/), podría verse así: + +```yaml +# cSpell:ignore +título: TítuloDeEntradaDelRegistro +``` + +Las herramientas del sitio web normalizan los diccionarios específicos de la +página (es decir, las listas de palabras `cSpell:ignore`), eliminando palabras +duplicadas, borrando palabras en la lista de palabras global y ordenando las +palabras. Para normalizar los diccionarios específicos de la página, ejecute +`npm run fix:dict`. + +## Formato de archivo + +Para hacer cumplir un estándar determinado sobre cómo se estructuran los +archivos, todos los archivos deben estar formateados por +[prettier](https://prettier.io). Ejecute `npm run fix:format` antes de enviar un +PR, o ejecutarlo después y enviar una confirmación adicional. + +## Nombres de archivos + +Todos los nombres de archivo deben estar en +[kebab case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case). Ejecute +`npm run fix:filenames` para cambiar automáticamente el nombre de sus archivos. From 9663314f82b751e152f5bf14431b3f6c9d110ff1 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Fri, 31 Jan 2025 14:50:50 +0100 Subject: [PATCH 02/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/en/docs/contributing/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index d54fc9332104..68102e64924d 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -2,6 +2,7 @@ title: Contributing aliases: [/docs/contribution-guidelines] weight: 980 +default_lang_commit: 4c5ca8e5b0876832ced6c1b57f8099f796794462 --- Thanks for your interest in contributing to the OpenTelemetry docs and website. From fd8f3ac8e5c0dfef4a0672875871ba3d6317ba29 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Sun, 2 Feb 2025 18:35:49 +0100 Subject: [PATCH 03/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/en/docs/contributing/_index.md | 1 - content/es/docs/contributing/_index.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 68102e64924d..d54fc9332104 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -2,7 +2,6 @@ title: Contributing aliases: [/docs/contribution-guidelines] weight: 980 -default_lang_commit: 4c5ca8e5b0876832ced6c1b57f8099f796794462 --- Thanks for your interest in contributing to the OpenTelemetry docs and website. diff --git a/content/es/docs/contributing/_index.md b/content/es/docs/contributing/_index.md index 064b6122d7c3..c9c32dc312b1 100644 --- a/content/es/docs/contributing/_index.md +++ b/content/es/docs/contributing/_index.md @@ -2,7 +2,7 @@ title: Contribuir description: Aprende cómo contribuir a la documentación de OpenTelemetry. weight: 980 -default_lang_commit: 4c5ca8e5b0876832ced6c1b57f8099f796794462 +default_lang_commit: 30783526402b69a3ac44eeb0f6cf066732f0bdca --- Quienes colaboran para documentar OpenTelemetry: From 7018367bf6dae3ccae7562b9204b6ea3f13d0fcf Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Fri, 7 Feb 2025 15:13:38 +0100 Subject: [PATCH 04/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/es/docs/contributing/_index.md b/content/es/docs/contributing/_index.md index c9c32dc312b1..91891400705c 100644 --- a/content/es/docs/contributing/_index.md +++ b/content/es/docs/contributing/_index.md @@ -2,7 +2,7 @@ title: Contribuir description: Aprende cómo contribuir a la documentación de OpenTelemetry. weight: 980 -default_lang_commit: 30783526402b69a3ac44eeb0f6cf066732f0bdca +default_lang_commit: 8eb480194ecba4c8b2ce9c16e5cc2947b5b532e2 --- Quienes colaboran para documentar OpenTelemetry: From 324ad5208b64bd63106cea485dad02d05c9172da Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Fri, 7 Feb 2025 15:33:24 +0100 Subject: [PATCH 05/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/_index.md | 2 +- content/es/docs/contributing/style-guide.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/es/docs/contributing/_index.md b/content/es/docs/contributing/_index.md index 91891400705c..c9c32dc312b1 100644 --- a/content/es/docs/contributing/_index.md +++ b/content/es/docs/contributing/_index.md @@ -2,7 +2,7 @@ title: Contribuir description: Aprende cómo contribuir a la documentación de OpenTelemetry. weight: 980 -default_lang_commit: 8eb480194ecba4c8b2ce9c16e5cc2947b5b532e2 +default_lang_commit: 30783526402b69a3ac44eeb0f6cf066732f0bdca --- Quienes colaboran para documentar OpenTelemetry: diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index 43da7cb4eb03..ca9d0f08fe18 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -4,6 +4,7 @@ description: Terminología y estilo al escribir documentos de OpenTelemetry. linkTitle: Estilo de documentación weight: 20 cSpell:ignore: open-telemetry postgre style-guide textlintrc +default_lang_commit: 8eb480194ecba4c8b2ce9c16e5cc2947b5b532e2 --- Aún no tenemos una guía de estilo oficial, pero el estilo actual de la From aa2eb90283bb3b876872298ee5f788208e0342b2 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Sun, 9 Feb 2025 18:35:32 +0100 Subject: [PATCH 06/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index ca9d0f08fe18..482b0fe753c0 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -4,7 +4,7 @@ description: Terminología y estilo al escribir documentos de OpenTelemetry. linkTitle: Estilo de documentación weight: 20 cSpell:ignore: open-telemetry postgre style-guide textlintrc -default_lang_commit: 8eb480194ecba4c8b2ce9c16e5cc2947b5b532e2 +default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167 --- Aún no tenemos una guía de estilo oficial, pero el estilo actual de la From a32c87e268e0b6459b3dae8823ee83c1212a42a3 Mon Sep 17 00:00:00 2001 From: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Date: Sun, 9 Feb 2025 19:44:39 +0000 Subject: [PATCH 07/12] Results from /fix:dict --- content/es/docs/contributing/style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index 482b0fe753c0..da4c1a4bc869 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -3,8 +3,8 @@ title: Guía de estilo de documentación description: Terminología y estilo al escribir documentos de OpenTelemetry. linkTitle: Estilo de documentación weight: 20 -cSpell:ignore: open-telemetry postgre style-guide textlintrc default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167 +cSpell:ignore: open-telemetry postgre style-guide textlintrc --- Aún no tenemos una guía de estilo oficial, pero el estilo actual de la From b6021518e3ff89ed6004b844c8dd87a032cf1c8b Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Wed, 12 Feb 2025 15:37:53 +0100 Subject: [PATCH 08/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/style-guide.md | 23 +++++++++++---------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index da4c1a4bc869..b21bb53f30d1 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -1,7 +1,8 @@ --- title: Guía de estilo de documentación -description: Terminología y estilo al escribir documentos de OpenTelemetry. -linkTitle: Estilo de documentación +description: + Terminología y estilo al escribir la documentación de OpenTelemetry. +linkTitle: Guía de estilo de documentación weight: 20 default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167 cSpell:ignore: open-telemetry postgre style-guide textlintrc @@ -10,26 +11,26 @@ cSpell:ignore: open-telemetry postgre style-guide textlintrc 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) -- [Kubernetes Estilo de documentación](https://kubernetes.io/docs/contribute/style/style-guide/) +- [Guía de estilo de documentación de para desarrolladores Google](https://developers.google.com/style) +- [Guía de estilo de documentación de Kubernetes](https://kubernetes.io/docs/contribute/style/style-guide/) -Las siguientes secciones contienen orientación específica para el proyecto +Las siguientes secciones contienen indicaciones específicas para el proyecto OpenTelemetry. {{% alert title="Note" color="primary" %}} -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 +automaticamente: antes de enviar un [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 -guía de estilo y aprenda qué puede hacer para solucionar ciertos asuntos +Si se producen errores o [fallan las comprobaciones de su PR](../pr-checks), lea +nuestra guía de estilo y aprenda qué puede hacer para solucionar ciertos asuntos comunes. {{% /alert %}} -## OpenTelemetry.io lista de palabras +## Lista de palabras de OpenTelemetry.io Una lista de términos y palabras específicos de OpenTelemetry que se deben usar de manera uniforme en todo el sitio: @@ -73,7 +74,7 @@ estándar. Ejecute `npm run fix:markdown` para corregir problemas de formato relacionados con Markdown. -## Corrección ortográfica +## Revisión ortográfica Utilice [CSpell](https://github.com/streetsidesoftware/cspell) para asegurarse de que todo su texto esté escrito correctamente. Para obtener una lista de From 193dde8833cad8d2b626c26c6489e0c35d4fe2a5 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Wed, 19 Feb 2025 09:51:28 +0100 Subject: [PATCH 09/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/style-guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index b21bb53f30d1..4a67b1c7061d 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -30,7 +30,7 @@ comunes. {{% /alert %}} -## Lista de palabras de OpenTelemetry.io +## Lista de palabras de OpenTelemetry.io {#opentelemetryio-word-list} Una lista de términos y palabras específicos de OpenTelemetry que se deben usar de manera uniforme en todo el sitio: @@ -60,7 +60,7 @@ están escritos correctamente. {{% /alert %}} -## Estándares de Markdown +## Estándares de Markdown {#markdown-standards} Para hacer cumplir los estándares y la coherencia de los archivos Markdown, todos los archivos deben seguir ciertas reglas, impuestas por @@ -74,7 +74,7 @@ estándar. Ejecute `npm run fix:markdown` para corregir problemas de formato relacionados con Markdown. -## Revisión ortográfica +## Revisión ortográfica {#spell-checking} Utilice [CSpell](https://github.com/streetsidesoftware/cspell) para asegurarse de que todo su texto esté escrito correctamente. Para obtener una lista de @@ -109,14 +109,14 @@ duplicadas, borrando palabras en la lista de palabras global y ordenando las palabras. Para normalizar los diccionarios específicos de la página, ejecute `npm run fix:dict`. -## Formato de archivo +## Formato de archivo {#file-format} Para hacer cumplir un estándar determinado sobre cómo se estructuran los archivos, todos los archivos deben estar formateados por [prettier](https://prettier.io). Ejecute `npm run fix:format` antes de enviar un PR, o ejecutarlo después y enviar una confirmación adicional. -## Nombres de archivos +## Nombres de archivos {#file-names} Todos los nombres de archivo deben estar en [kebab case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case). Ejecute From 6be79b6a252f692084d853bd1082256ac58f0a1a Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Wed, 19 Feb 2025 10:37:52 +0100 Subject: [PATCH 10/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- .cspell/es-palabras.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.cspell/es-palabras.txt b/.cspell/es-palabras.txt index c031a6dfa5f7..51dbd3b2fb10 100644 --- a/.cspell/es-palabras.txt +++ b/.cspell/es-palabras.txt @@ -16,3 +16,5 @@ monitoreo multilenguaje redireccionar prerrellenada +opentelemetryio + From e3ac5362ad6b1db51ac72ea9ee768ef6018b29a2 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Wed, 19 Feb 2025 15:47:02 +0100 Subject: [PATCH 11/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- .cspell/es-palabras.txt | 2 -- content/es/docs/contributing/style-guide.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.cspell/es-palabras.txt b/.cspell/es-palabras.txt index 51dbd3b2fb10..c031a6dfa5f7 100644 --- a/.cspell/es-palabras.txt +++ b/.cspell/es-palabras.txt @@ -16,5 +16,3 @@ monitoreo multilenguaje redireccionar prerrellenada -opentelemetryio - diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index 4a67b1c7061d..379086c6a99a 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -5,7 +5,7 @@ description: linkTitle: Guía de estilo de documentación weight: 20 default_lang_commit: 99f0ae5760038d51f9e9eb376bb428a2caca8167 -cSpell:ignore: open-telemetry postgre style-guide textlintrc +cSpell:ignore: open-telemetry opentelemetryio postgre style-guide textlintrc --- Aún no tenemos una guía de estilo oficial, pero el estilo actual de la From 6961c4a67f5bfdcdf2a1166ee63c363ff686ba74 Mon Sep 17 00:00:00 2001 From: Diana Todea Date: Wed, 19 Feb 2025 16:24:47 +0100 Subject: [PATCH 12/12] feat: [es] Create docs/contributing/style-guide.md Signed-off-by: Diana Todea --- content/es/docs/contributing/style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/es/docs/contributing/style-guide.md b/content/es/docs/contributing/style-guide.md index 379086c6a99a..a2a99427754b 100644 --- a/content/es/docs/contributing/style-guide.md +++ b/content/es/docs/contributing/style-guide.md @@ -89,7 +89,7 @@ dicha sección, puede agregarla al principio de un archivo Markdown: ```markdown --- -título: TítuloDeLaPágina +title: TítuloDeLaPágina cSpell:ignore: --- ``` @@ -100,7 +100,7 @@ entrada [registry](/ecosystem/registry/), podría verse así: ```yaml # cSpell:ignore -título: TítuloDeEntradaDelRegistro +title: TítuloDeEntradaDelRegistro ``` Las herramientas del sitio web normalizan los diccionarios específicos de la