From 286225b017a79df149cd7849a81124f8f0f8ad52 Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Mon, 30 Sep 2024 02:31:22 -0400 Subject: [PATCH 01/21] fix: :bug: remove markdown list enumerator to display content in mermaid chart --- content/en/docs/contributing/new-content.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/en/docs/contributing/new-content.md b/content/en/docs/contributing/new-content.md index 7ccb57284f95..dfb15fe53c59 100644 --- a/content/en/docs/contributing/new-content.md +++ b/content/en/docs/contributing/new-content.md @@ -54,14 +54,14 @@ A([fa:fa-user New
Contributor]) --- id1[(open-telemetry/opentelemetry.io
G subgraph tasks[Changes using GitHub] direction TB 0[ ] -.- - 1[1. Edit this page] --> 2[2. Use GitHub markdown
editor to make changes] - 2 --> 3[3. fill in Propose file change] + 1[Edit this page] --> 2[Use GitHub markdown
editor to make changes] + 2 --> 3[fill in Propose file change] end subgraph tasks2[ ] direction TB -4[4. select Propose file change] --> 5[5. select Create pull request] --> 6[6. fill in Open a pull request] -6 --> 7[7. select Create pull request] +4[select Propose file change] --> 5[select Create pull request] --> 6[fill in Open a pull request] +6 --> 7[select Create pull request] end id1 --> tasks --> tasks2 @@ -275,15 +275,15 @@ Figure 4 shows the steps to open a PR from your fork to flowchart LR subgraph first[ ] direction TB -1[1. Go to opentelemetry.io repository] --> 2[2. Select New Pull Request] -2 --> 3[3. Select compare across forks] -3 --> 4[4. Select your fork from
head repository drop-down menu] +1[Go to opentelemetry.io repository] --> 2[Select New Pull Request] +2 --> 3[Select compare across forks] +3 --> 4[Select your fork from
head repository drop-down menu] end subgraph second [ ] direction TB -5[5. Select your branch from
the compare drop-down menu] --> 6[6. Select Create Pull Request] -6 --> 7[7. Add a description
to your PR] -7 --> 8[8. Select Create pull request] +5[Select your branch from
the compare drop-down menu] --> 6[Select Create Pull Request] +6 --> 7[Add a description
to your PR] +7 --> 8[Select Create pull request] end first --> second From d76b1dae7cb826ba396c184a6b8a71107856a80a Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Mon, 30 Sep 2024 02:33:34 -0400 Subject: [PATCH 02/21] docs: :memo: create add new content page in spanish --- content/es/docs/contributing/new-content.md | 522 ++++++++++++++++++++ 1 file changed, 522 insertions(+) create mode 100644 content/es/docs/contributing/new-content.md diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/new-content.md new file mode 100644 index 000000000000..2272017f9b56 --- /dev/null +++ b/content/es/docs/contributing/new-content.md @@ -0,0 +1,522 @@ +--- +title: Agregar nuevo contenido +description: + Aprende a agregar contenido nuevo utilizando la interfaz de GitHub o + localmente. +weight: 2 +default_lang_commit: f724c15be360e5059fb89e696d9a5cc8d00496f6 +--- + +Para contribuir con nuevas páginas de contenido o mejorar las páginas de +contenido existentes, abra un Pull Request (PR): + +- Si tu cambio es pequeño, o ya estás familiarizado con Git, lee + [Realizando cambios con Github](#changes-using-github) para aprender a editar + la página desde la interfaz de Github. +- Si tus cambio es mayor, lee [trabajando desde una rama local](#fork-the-repo) + para aprender cómo realizar cambios localmente desde tu computadora. + +{{% alert title="Tip" %}} + +Convierte tu Pull Request en borrador para indicar que el contenido aún no está +listo para su revisión. Los encargados aún pueden comentar o realizar revisiones +de alto nivel, aunque no revisarán el contenido en su totalidad hasta que +indiques que ya no es un borrador. + +{{% /alert %}} + +La siguiente figura ilustra cómo contribuir con nueva documentación. + +```mermaid +flowchart LR + subgraph first[Cómo contribuir] + direction TB + T[ ] -.- + B[Haz un fork al repo de Github] --- C[Escribe el nuevo contenido utilizando Markdown
y empaqueta la página web en Hugo] + C --- D[Sube tus cambios locales al Fork] + D --- E[Abre un Pull Request] + E --- F[Firma el CNCF CLA] + end + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,B,C,D,E,F,G,H grey +class S,T spacewhite +class first,second white +``` + +_Figure 1. Contribuyendo con nuevo contenido._ + +## Realizando cambios con Github {#changes-using-github} + +Si no tienes tanta experiencia con Git, aquí tienes un método más sencillo para +abrir un Pull Request. La Figura 2 describe los pasos y los detalles a +continuación. + +```mermaid +flowchart LR +A([fa:fa-user Nuevo
Contribuyente]) --- id1[(open-telemetry/opentelemetry.io
GitHub)] +subgraph tasks[Editando en Github] +direction TB + 0[ ] -.- + 1[Edita esta página] --> 2[Usa el editor de markdown en Github
para hacer tus cambios] + 2 --> 3[agrega tus propuesta de cambios] + +end +subgraph tasks2[ ] +direction TB +4[Selecciona tus archivos a cambiar] --> 5[Haz click en Crear Pull Request] --> 6[Llena los cambios en Abriendo un Pull Request] +6 --> 7[Haz click en Crear pull request] +end + +id1 --> tasks --> tasks2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,1,2,3,4,5,6,7 grey +class 0 spacewhite +class tasks,tasks2 white +class id1 k8s +``` + +_Figure 2. Pasos para abrir un Pull Request desde Github._ + +1. En la página de la tarea en Github, haz click **Editar esta página** en el + panel de navegación en la derecha. + +1. Si no eres miembro de este proyecto, puedes hacer fork al repositorio de + Github. Dando click en **Fork**. + +1. Haz tus cambios desde el editor de Github. + +1. Llena el formulario de **Subir cambios**. + +1. Haz click en **Proponer cambios**. + +1. Haz click en **Crear pull request**. + +1. Cuando la pantalla de **Abrir un pull request** aparezca. Agrega una + descripción para que los supervisores puedan comprender tus cambios. + +1. Haz click en **Crear pull request**. + +Antes de hacer merge de tus cambios, Los miembros de la comunidad de +OpenTelemetry harán revisión de tus cambios y los aprobarán. + +Si un miembro te pide hacer cambios: + +1. Ve a la pestaña de **Archivos cambiados**. +1. Haz click en el ícono del lápiz (Editar) en cualquiera de los archivos + cambiados en tu pull request. +1. Haz los cambios solicitados. Si hay alguna sugerencia de código, aplícala. +1. Haz commit de tus cambios. + +Cuando la revisión a terminado, un miemrbo de la comunidad hará merge de tu pull +request y tus cambios estarán disponibles al público en algunos minutos. + +{{% alert title="Tip" %}} + +Haz un comentario con `/fix:format` en tu pull request para realizar una +revisión automática de formateo de tus cambios. + +{{% /alert %}} + +## Trabajar desde una rama local {#fork-the-repo} + +Si eres un usuario más experimentado con Git, o tus cambios ameritan varios +archivos a la vez, preferirás trabajar desde una rama local. + +Asegurate de que tienes +[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) instalado +en tu computadora. También puedes usar una interfáz gráfica de Git. + +La figura 3 muestra los pasos a seguir cuando se trabaja desde una rama local. A +continuación se detallan los pasos. + +```mermaid +flowchart LR +1[Haz fork del repositorio
open-telemetry/opentelemetry] --> 2[Crea una rama local
y agrega el remote upstream] +subgraph changes[Tus cambios] +direction TB +S[ ] -.- +3[Crea una rama
ejemplo: mi_nueva_rama] --> 3a[Haz los cambios
en un editor de texto] --> 4["Revisa tus cambios
localmente usando Hugo
(localhost:1313)"] +end +subgraph changes2[Haz Commit / Push] +direction TB +T[ ] -.- +5[Haz commit de tus cambios] --> 6[Haz push de tus cambios
origin/mi_nueva_rama] +end + +2 --> changes --> changes2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class 1,2,3,3a,4,5,6 grey +class S,T spacewhite +class changes,changes2 white +``` + +_Figure 3. Trabajando desde una rama local para hacer cambios._ + +### Haz fork al repositorio de opentelemetry.io + +1. Navega al repositorio + [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) . +1. Haz click en **Fork**. + +### Crea un clon local y agrega el upstream + +1. En tu terminal, clona tu fork y instala las dependencias: + + ```shell + git clone git@github.com:/opentelemetry.io.git + cd opentelemetry.io + npm install + ``` + +1. Coloca el repositorio de `open-telemetry/opentelemetry.io` como el `upstream` + remote: + + ```shell + git remote add upstream https://github.com/open-telemetry/opentelemetry.io.git + ``` + +1. Confirma los valores de los remotes `origin` y `upstream`: + + ```shell + git remote -v + ``` + + La salida debe ser similar a: + + ```none + origin git@github.com:/opentelemetry.io.git (fetch) + origin git@github.com:/opentelemetry.io.git (push) + upstream https://github.com/open-telemetry/opentelemetry.io.git (fetch) + upstream https://github.com/open-telemetry/opentelemetry.io.git (push) + ``` + +1. Actualiza los cambios de la rama `origin/main` en tu fork y la rama + `upstream/main` del repositorio original `open-telemetry/opentelemetry.io`: + + ```shell + git fetch origin + git fetch upstream + ``` + +Esto se asegura de que tu repositorio local está actualizado antes de que +empieces a hacer tus cambios localmente. Realiza esto frecuentemente para +mantener tu copia local sincronizada con la versión en el repositorio original. + +### Crea una rama + +1. Crea una rama. Este ejemplo asume que tomaremos de referencia la rama + `upstream/main`: + + ```shell + git checkout -b upstream/main + ``` + +1. Haz tus cambios en tu editor de código favorito. + +Regularmente, utiliza el comando `git status` para visualizar los archivos que +haz cambiado. + +### Haz commit de tus cambios + +Cuando estás listo para subir tu pull request, haz commit de tus cambios. + +1. En tu repositorio local, revisa los cambios que necesitas hacer commit: + + ```shell + git status + ``` + + La salida debe ser similar a: + + ```none + On branch + Your branch is up to date with 'origin/'. + + Changes not staged for commit: + (use "git add ..." to update what will be committed) + (use "git checkout -- ..." to discard changes in working directory) + + modified: content/en/docs/nombre_de_tu_archivo.md + + no changes added to commit (use "git add" and/or "git commit -a") + ``` + +1. Agrega los archivos listados debajo de **Changes not staged for commit** al + commit: + + ```shell + git add + ``` + + Repite esto para cada uno de los archivos a subir. + +1. Luego de modificar todos los archivos, crea un commit: + + ```shell + git commit -m "Mensaje de tu commit" + ``` + +1. Sube los cambios a tu rama local: + + ```shell + git push origin + ``` + +1. Una vez tus cambios fueron subidos, GitHub te notifica si quieres crear un + Pull Request (PR) de tus cambios. + +### Abrir un Pull Request de tu Fork {#open-a-pr} + +La Figura 4 muestra los pasos para abrir un PR desde tu rama a +[opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io). + +```mermaid +flowchart LR +subgraph first[ ] +direction TB +1[Abre el repositorio opentelemetry.io] --> 2[Haz click en nuevo Pull Request] +2 --> 3[Haz click en comparar entre forks] +3 --> 4[Selecciona tu fork
desde el drop-down] +end +subgraph second [ ] +direction TB +5[Selleciona tu rama desde
el menu de comparación] --> 6[Haz click en crear nuevo Pull Request] +6 --> 7[Agrega una descripción
a tu PR] +7 --> 8[Haz click en crear pull request] +end + +first --> second + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +class 1,2,3,4,5,6,7,8 grey +class first,second white +``` + +\_Figure 4. Pasos para abrir un PR desde tu fork a +[opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io). + +1. En un navegador web, vaya al repositorio + [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io) . +1. Seleccione **Nuevo Pull Request**. +1. Seleccione **Comparar ramas**. +1. En el menú desplegable **repositorio principal**, seleccione su rama. +1. En el menú desplegable **Comparar**, seleccione tu rama. +1. Seleccione **Crear Pull Request**. +1. Agregue una descripción para tu pull request: + + - **Título** (50 caracteres o menos): Resume la intención del cambio. + - **Descripción**: Describe el cambio con más detalle. + + - Si hay un problema de GitHub relacionado, incluye `Fixes #12345` o + `Closes #12345` en la descripción para que la automatización de GitHub + cierre el problema mencionado después de fusionar el PR. Si hay otros PR + relacionados, vincúlalos también. + - Si quieres asesoramiento sobre algo específico, incluye cualquier pregunta + que te gustaría que los miembros consideren en tu descripción. + +1 Haz click en el botón **Crear pull request**. + +Tu pull request estará disponible en +[pull Requests](https://github.com/open-telemetry/opentelemetry.io/pulls). + +Después de abrir un PR, GitHub ejecuta pruebas automatizadas e intenta +implementar una vista previa usando [Netlify](https://www.netlify.com/). + +- Si la compilación de Netlify falla, seleccione **Detalles** para obtener más + información. +- Si la compilación de Netlify se realiza correctamente, seleccione **Detalles** + para abrir una versión preparada del sitio web de OpenTelemetry con los + cambios aplicados. Así es como los revisores verifican sus cambios. + +También pueden fallar otras comprobaciones. Consulte la +[lista de todas las comprobaciones de PR](/docs/contributing/pr-checks). + +### Soluciona problemas de contenido automáticamente + +Antes de enviar un cambio al repositorio, ejecuta el siguiente comando y (i) +aborda los problemas informados, (ii) confirma los archivos modificados por el +script: + +```sh +npm run test-and-fix +``` + +Para probar y solucionar por separado todos los problemas con tus archivos, +ejecuta: + +```sh +npm run test # Checks but does not update any files +npm run fix:all # May update files +``` + +Para enumerar los scripts NPM disponibles, ejecuta `npm run`. Consulta +[Los pre-requisitos de PR](/docs/contributing/pr-checks) para obtener más +información sobre las verificaciones de los Pull Request y cómo solucionar +errores automáticamente. + +### Obtén una vista previa de tus cambios localmente {#preview-locally} + +Obtén una vista previa de tus cambios localmente antes de enviarlos o abrir un +pull request. Una vista previa te permite detectar errores de compilación o +problemas de formato de Markdown. + +Para crear y servir el sitio localmente con Hugo, ejecute el siguiente comando: + +```shell +npm run serve +``` + +Navegue a `http://localhost:1313` en su navegador web para ver la vista previa +local. Hugo observa los cambios y reconstruye el sitio según sea necesario. + +Para detener la instancia local de Hugo, vuelva a la terminal y escriba +`Ctrl+C`, o cierre la ventana de la terminal. + +### Implementaciones del sitio y vistas previas de PR + +Si envía una PR, Netlify crea una vista previa de implementación para que pueda +revisar sus cambios. Una vez que se fusiona su PR, Netlify implementa el sitio +actualizado en el servidor de producción. + +> **Nota**: Las vistas previas de PR incluyen _páginas de borrador_, pero las +> compilaciones de producción no. + +Para ver los registros de implementación y más, visite el [panel de control][] +del proyecto -- Se requiere inicio de sesión en Netlify. + +### Pautas de PR + +Antes de fusionar un PR, a veces se requieren algunas iteraciones de revisión y +edición. Para ayudarnos a nosotros y a usted mismo a hacer que este proceso sea +lo más sencillo posible, le pedimos que respete lo siguiente: + +- Si su PR no es una solución rápida, entonces **trabaje desde una copia**: haga + clic en el botón + [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) en la parte + superior del repositorio y clone el repositorio localmente. Cuando esté listo, + genere un PR al repositorio original. +- **No trabaje desde la rama `main`** de su fork, sino que cree una rama + específica para el PR. +- Asegúrate de que los mantenedores tengan permiso para aplicar cambios a tu + solicitud de incorporación de cambios + (https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). + +### Cambios de los revisores + +A veces, los revisores se suben cambios en tu pull request. Antes de realizar +cualquier otro cambio, actualiza tu rama. + +1. Actualiza los commits de tu fork y haz rebase de tu rama actual: + + ```shell + git fetch origin + git rebase origin/ + ``` + +1. Luego de hacer rebase, sube tus nuevos cambios a tu fork: + + ```shell + git push --force-with-lease origin + ``` + +También puedes resolver conflictos de fusión desde la interfaz de usuario de +GitHub. + +### Conflictos en ramas y git rebase + +Si otro colaborador realiza cambios en el mismo archivo en otro pull request, +puede crear un merge. Es tu responsabilidad resolver todos los conflictos en tu +Pull Request. + +1. Actualiza tu fork y haz git rebase de tu rama local: + + ```shell + git fetch origin + git rebase origin/ + ``` + + Luego haz force-push de tus cambios a tu fork: + + ```shell + git push --force-with-lease origin + ``` + +1. Actualiza los cambios de la rama `upstream/main` en + `open-telemetry/opentelemetry.io` y haz git rebase a tu rama actual: + + ```shell + git fetch upstream + git rebase upstream/main + ``` + +1. Inspecciona los resultados del git rebase: + + ```shell + git status + ``` + + Esto indicará la cantidad de archivos marcados con conflictos. + +1. Abra cada archivo en conflicto y busque los marcadores de conflicto: `>>>`, + `<<<`, y `===`. Resuelva el conflicto y elimine el marcador de conflicto. + +Para obtener más información, consulte +[Cómo se presentan los conflictos](https://git-scm.com/docs/git-merge#_how_conflicts_are_presented). + +1. Agregue los archivos al conjunto de cambios: + + ```shell + git add + ``` + +1. Continúe con el rebase: + + ```shell + git rebase --continue + ``` + +1. Repita los pasos 2 a 5 según sea necesario. + + Después de aplicar todas las confirmaciones, el comando `git status` muestra + que el rebase está completo. + +1. Haz force push de los cambios en tu rama a tu fork: + + ```shell + git push --force-with-lease origin + ``` + + El pull request ya no muestra ningún conflicto. + +### Requisitos para hacer merge + +Los pull request se hacen merge cuando cumplen con los siguientes criterios: + +- Todas las revisiones realizadas por aprobadores, mantenedores, miembros del + comité técnico o expertos en la materia tienen el estado "Aprobado". +- No hay conversaciones sin resolver. +- Aprobado por al menos un aprobador. +- No hay comprobaciones de PR fallidas. +- La rama de PR está actualizada con la rama base. + +> **Importante** +> +> No te preocupes demasiado por las comprobaciones de PR fallidas. Los miembros +> de la comunidad te ayudarán a solucionarlas, ya sea proporcionándote +> instrucciones sobre cómo solucionarlas o solucionándolas en tu nombre. + +[Panel de Control]: https://app.netlify.com/sites/opentelemetry/overview +[Vista previa]: + https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/ From d7cd84fcdc1bdb3e1d2aef0e8c06ca0b1eeb3327 Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Mon, 30 Sep 2024 02:38:39 -0400 Subject: [PATCH 03/21] chore: :memo: capitalize link declarations --- content/es/docs/contributing/new-content.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/new-content.md index 2272017f9b56..46f13259b891 100644 --- a/content/es/docs/contributing/new-content.md +++ b/content/es/docs/contributing/new-content.md @@ -386,14 +386,14 @@ Para detener la instancia local de Hugo, vuelva a la terminal y escriba ### Implementaciones del sitio y vistas previas de PR -Si envía una PR, Netlify crea una vista previa de implementación para que pueda -revisar sus cambios. Una vez que se fusiona su PR, Netlify implementa el sitio -actualizado en el servidor de producción. +Si envía una PR, Netlify crea una [Vista Previa de Implementación][] para que pueda +revisar sus cambios. Una vez que se fusiona su PR, Netlify implementa el sitio actualizado +en el servidor de producción. > **Nota**: Las vistas previas de PR incluyen _páginas de borrador_, pero las > compilaciones de producción no. -Para ver los registros de implementación y más, visite el [panel de control][] +Para ver los registros de implementación y más, visite el [Panel de Control][] del proyecto -- Se requiere inicio de sesión en Netlify. ### Pautas de PR @@ -518,5 +518,5 @@ Los pull request se hacen merge cuando cumplen con los siguientes criterios: > instrucciones sobre cómo solucionarlas o solucionándolas en tu nombre. [Panel de Control]: https://app.netlify.com/sites/opentelemetry/overview -[Vista previa]: +[Vista Previa de Implementación]: https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/ From 25636cae6049042a0722559a7832e706156898c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Mon, 30 Sep 2024 08:25:24 +0200 Subject: [PATCH 04/21] OTel .NET Auto - typo fixes propagators -> exporters (#5269) --- content/en/docs/zero-code/net/configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/zero-code/net/configuration.md b/content/en/docs/zero-code/net/configuration.md index cbb5d65ac91a..1c15742168f7 100644 --- a/content/en/docs/zero-code/net/configuration.md +++ b/content/en/docs/zero-code/net/configuration.md @@ -147,11 +147,11 @@ probability, a number in the [0..1] range, e.g. "0.25". Default is 1.0. Exporters output the telemetry. -| Environment variable | Description | Default value | Status | -| ----------------------- | ------------------------------------------------------------------------------------------------ | ------------- | --------------------------------------------------- | -| `OTEL_TRACES_EXPORTER` | Comma-separated list of propagators. Supported options: `otlp`, `zipkin`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | -| `OTEL_METRICS_EXPORTER` | Comma-separated list of propagators. Supported options: `otlp`, `prometheus`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | -| `OTEL_LOGS_EXPORTER` | Comma-separated list of propagators. Supported options: `otlp`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | +| Environment variable | Description | Default value | Status | +| ----------------------- | ---------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------------- | +| `OTEL_TRACES_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `zipkin`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | +| `OTEL_METRICS_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `prometheus`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | +| `OTEL_LOGS_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `console`, `none`. | `otlp` | [Stable](/docs/specs/otel/versioning-and-stability) | ### Traces exporter From d787c50b977a026517bc44520392256a5fca4bcc Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 30 Sep 2024 02:26:06 -0400 Subject: [PATCH 05/21] OTel Arrow blog drive-by copyedits (#5268) --- content/en/blog/2023/otel-arrow/index.md | 4 ++-- .../en/blog/2024/otel-arrow-production/index.md | 15 +++++++-------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/content/en/blog/2023/otel-arrow/index.md b/content/en/blog/2023/otel-arrow/index.md index 9f496d1469c5..afd27364d60d 100644 --- a/content/en/blog/2023/otel-arrow/index.md +++ b/content/en/blog/2023/otel-arrow/index.md @@ -24,8 +24,8 @@ repository that supports this protocol. This protocol, designed to complement the OTLP protocol in situations with substantial telemetry data volumes, has been under discussion and development for two years. It represents a collaborative effort between [F5](https://f5.com), -[ServiceNow Cloud Observability](https://www.servicenow.com/products/observability.html) -, and numerous technical leaders from the OpenTelemetry community (see +[ServiceNow Cloud Observability](https://www.servicenow.com/products/observability.html), +and numerous technical leaders from the OpenTelemetry community (see [donation](https://github.com/open-telemetry/community/issues/1332)). The compression benefits are significant, demonstrating a **40% improvement compression efficiency** for the majority of workloads and even greater diff --git a/content/en/blog/2024/otel-arrow-production/index.md b/content/en/blog/2024/otel-arrow-production/index.md index a63b0abdcb31..ac27be966449 100644 --- a/content/en/blog/2024/otel-arrow-production/index.md +++ b/content/en/blog/2024/otel-arrow-production/index.md @@ -2,10 +2,9 @@ title: OpenTelemetry Protocol with Apache Arrow in Production linkTitle: OpenTelemetry Arrow in Production date: 2024-09-25 -author: - >- # If you have only one author, then add the single name on this line in quotes. - [Joshua MacDonald](https://github.com/jmacd) (ServiceNow, Inc), [Laurent - Querel](https://github.com/lquerel) (F5, Inc) +author: >- + [Joshua MacDonald](https://github.com/jmacd) (ServiceNow), [Laurent + Querel](https://github.com/lquerel) (F5) cSpell:ignore: Querel Zstd issue: 5193 sig: OpenTelemetry Arrow @@ -54,8 +53,8 @@ OpenTelemetry Collectors. The compression bridge consists of two OpenTelemetry Collectors labeled exporter and receiver, or they could equally be two pools of load-balanced collectors. -As described in this -["OTEP" design document](https://github.com/open-telemetry/oteps/blob/main/text/0156-columnar-encoding.md#mapping-otel-entities-to-arrow-records), +As described in the +[OTEP 0156 design document](https://github.com/open-telemetry/oteps/blob/main/text/0156-columnar-encoding.md#mapping-otel-entities-to-arrow-records), the exporter converts arbitrary OpenTelemetry data into an Arrow record batch. The Arrow record batch is a block of memory, with a standardized layout, making it possible to exchange data across address spaces and virtual process @@ -224,7 +223,7 @@ giving them an opportunity to retry on another connection, and it gives the service operator a chance to auto-scale the number of instances to handle the increase in load based on memory utilization. -See the +For details, see the [documentation on batching and back-pressure](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/otelarrowexporter/README.md#batching-configuration) for the OTel-Arrow exporter. @@ -246,7 +245,7 @@ the OpenTelemetry standard OTLP over gRPC, with round-robin load balancing. The gateway collectors apply a variety of processors, including the concurrent batch processor described above, followed by the OTel-Arrow exporter. -![A pool of gateway collectors sends to a load balancer, then to a backend service.](./setup.png) +![A pool of gateway collectors sends to a load balancer, then to a backend service.](setup.png) On the other side of the bridge, a pool of Envoy load balancers distributes the streams across a pool of collectors running the OTel-Arrow receiver, after From 41f6fd572ad45ba6a8f3fd238e3591996d07e4fa Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 30 Sep 2024 02:26:24 -0400 Subject: [PATCH 06/21] Contributing: improved guidance for quick-fixers, mentees, and more (#5266) --- .htmltest.yml | 2 + content/en/docs/contributing/_index.md | 55 +++++++++++++------ content/en/docs/contributing/development.md | 3 +- content/en/docs/contributing/issues.md | 50 ++++++++++++++++- content/en/docs/contributing/pr-checks.md | 23 ++++---- content/en/docs/contributing/prerequisites.md | 43 +++++++++++++++ .../{new-content.md => pull-requests.md} | 47 ++++++++++------ content/en/docs/contributing/requirements.md | 33 ----------- content/en/docs/contributing/style-guide.md | 4 +- static/refcache.json | 4 ++ 10 files changed, 180 insertions(+), 84 deletions(-) create mode 100644 content/en/docs/contributing/prerequisites.md rename content/en/docs/contributing/{new-content.md => pull-requests.md} (91%) delete mode 100644 content/en/docs/contributing/requirements.md diff --git a/.htmltest.yml b/.htmltest.yml index 4744a0a95ced..755573156871 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -8,6 +8,8 @@ CheckMailto: false TestFilesConcurrently: true IgnoreDirs: - ^blog/(\d+/)?page/\d+ + # TODO drop after https://github.com/open-telemetry/opentelemetry.io/issues/5267 is fixed: + - zh/docs/contributing/pr-checks IgnoreInternalURLs: # list of paths IgnoreURLs: # list of regexs of paths or URLs to be ignored - ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$ diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 9cdf69880ed2..4fc089ff9475 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -1,29 +1,52 @@ --- title: Contributing -description: Learn how to contribute to OpenTelemetry documentation. aliases: [/docs/contribution-guidelines] weight: 980 --- +Thanks for your interest in contributing to the OpenTelemetry docs and website. + +## Jump right in! + +What do you want to do? + +- Correct a **typo or other quick fixes**, see + [Submitting content using GitHub](pull-requests/#changes-using-github) +- For more significant contributions, read the pages in this section starting + with: + - [Prerequisites] + - [Issues] + - [Submitting content] + +[Prerequisites]: prerequisites/ +[Issues]: issues/ +[Submitting content]: pull-requests/ + +{{% alert title=" First time contributing? " %}} + +Eager first-time contributors, see +[Fixing an existing issue](issues/#fixing-an-existing-issue) for important +guidance. + +{{% /alert %}} + +## What can I contribute to? + OpenTelemetry documentation contributors: -- Improve existing content. -- Create new content. -- Update the OpenTelemetry Registry. -- Improve the code that builds the site. +- Improve existing or create new content +- [Submit a blog post](blog/) or case study +- Add to or update the [OpenTelemetry Registry](/ecosystem/registry/) +- Improve the code that builds the site -The following guides describe how to contribute to OpenTelemetry documentation. +The pages in this section describe how to contribute to OpenTelemetry +**documentation**. For guidance on how to contribute to the OpenTelemetry project in general, see -the -[OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md) -, which provides details on the Contributor License Agreement and the Code of -Conduct. Every language implementation, Collector, and conventions -[repository](https://github.com/open-telemetry/) has its own specific +the community [OpenTelemetry New Contributor Guide]. Every [OTel repository][org] +for language implementations, the Collector, and conventions have their own project-specific contributing guides. -## Other ways to contribute - -- Visit the [OpenTelemetry community site](/community/). -- Add your application to the [Registry](/ecosystem). -- Submit a [blog post or case study](/docs/contributing/blog/). +[OpenTelemetry New Contributor Guide]: + https://github.com/open-telemetry/community/blob/main/guides/contributor +[org]: https://github.com/open-telemetry diff --git a/content/en/docs/contributing/development.md b/content/en/docs/contributing/development.md index 570aced402f2..434eade6a876 100644 --- a/content/en/docs/contributing/development.md +++ b/content/en/docs/contributing/development.md @@ -1,5 +1,6 @@ --- -title: Development +title: Development setup and commands to build, serve, and more +linkTitle: Dev setup and more description: Learn how to set up a development environment for the opentelemetry.io site. weight: 60 diff --git a/content/en/docs/contributing/issues.md b/content/en/docs/contributing/issues.md index 4aeca18c85e9..dadea2c29fbe 100644 --- a/content/en/docs/contributing/issues.md +++ b/content/en/docs/contributing/issues.md @@ -1,10 +1,54 @@ --- -title: Reporting an issue -description: How to report a bug, a security issue, or a potential improvement. -weight: 50 +title: Issues +description: + How to fix an existing issue, or report a bug, security risk, or potential + improvement. +weight: 10 cSpell:ignore: prepopulated +_issues: https://github.com/open-telemetry/opentelemetry.io/issues +_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A --- +## Fixing an existing issue + +One of the best ways to help make OTel docs better is to fix an existing issue. + +1. Browse through the list of [issues]({{% param _issues %}}). +2. Select an issue that you would like to work on, ideally one that you can fix + in a short amount of time. + + + + {{% alert title="First time contributing? " %}} + + Select an issue with the following labels: + + - [Good first issue] + - [Help wanted] + + + > **NOTE**: we **_do not_ assign issues** to those who + > have not already made contributions to the [OpenTelemetry + > organization][org]. + {.mt-3} + + + [good first issue]: {{% param _issue %}}%22good+first+issue%22 + [help wanted]: {{% param _issue %}}%3A%22help+wanted%22 + [org]: https://github.com/open-telemetry + + {{% /alert %}} + +3. Read through the issue comments, if any. +4. Ask maintainers if this issue is still relevant, and ask any questions you + need for clarification by posting comments over the issue. +5. Share your intention to work on the issue by adding add a comment to this + effect. +6. Work on fixing the issue. Let maintainers now if you run into any problems. +7. When ready, [submit your work through a pull request](../pull-requests) (PR). + +## Reporting an issue + If you notice an error or want to suggest improvements to existing content, open an issue. diff --git a/content/en/docs/contributing/pr-checks.md b/content/en/docs/contributing/pr-checks.md index d59ce9abcb47..aa4cfb65bc53 100644 --- a/content/en/docs/contributing/pr-checks.md +++ b/content/en/docs/contributing/pr-checks.md @@ -18,8 +18,8 @@ a set of checks are executed. The PR checks verify that... {{% alert title="Note" color="primary" %}} -If any of the PR checks fails, please try to -[fix content issues automatically](/docs/contributing/new-content/#fix-content-issues-automatically) +If any of the PR checks fails, try to +[fix content issues automatically](../pull-requests/#fix-content-issues-automatically) first by running `npm run fix:all` on your machine. Additionally, you can comment `/fix:all` on your Pull Request. This will make @@ -33,8 +33,7 @@ can recover from a failed state. ## Easy CLA -This check fails if you haven't -[signed the CLA](/docs/contributing/requirements/#sign-the-cla). +This check fails if you haven't [signed the CLA](../prerequisites/#cla). ## Netlify deployment @@ -43,9 +42,9 @@ more information. ## Style checks -To make sure that contributions follow our -[style guide](/docs/contributing/style-guide) we have implemented a set of -checks that verify style guide rules and fail l if they find any issues. +To make sure that contributions follow our [style guide](../style-guide/) we +have implemented a set of checks that verify style guide rules and fail l if +they find any issues. The following list describes current checks and what you can do to fix related errors: @@ -53,7 +52,7 @@ errors: ### TEXT linter This check verifies that -[OpenTelemetry-specific terms and words are used consistently across the site](/docs/contributing/style-guide#opentelemetryio-word-list). +[OpenTelemetry-specific terms and words are used consistently across the site](../style-guide/#opentelemetryio-word-list). If any issues are found, annotations are added to your files in the `files changed` view of your PR. Fix those to turn the check green. As an @@ -63,7 +62,7 @@ issues. Run `npm run check:text` again and manually fix the remaining issues. ### MARKDOWN linter This check verifies that -[standards and consistency for Markdown files are enforced](/docs/contributing/style-guide#markdown-standards). +[standards and consistency for Markdown files are enforced](../style-guide/#markdown-standards). If any issues are found, run `npm:run format` to fix most issues. For more complex issues, run `npm run check:markdown` and apply the suggested changes. @@ -71,7 +70,7 @@ complex issues, run `npm run check:markdown` and apply the suggested changes. ### SPELLING check This check verifies that -[all words are spelled correctly](/docs/contributing/style-guide#spell-checking). +[all words are spelled correctly](../style-guide/#spell-checking). ### CSPELL:IGNORE check @@ -83,7 +82,7 @@ new commit. ### FILENAME check This check verifies that all -[files are formatted by prettier](/docs/contributing/style-guide#file-format). +[files are formatted by prettier](../style-guide/#file-format). If this check fails, run `npm fix:format` locally and push the changes in a new commit. @@ -91,7 +90,7 @@ commit. ### FILE FORMAT This check verifies that all -[file names are in kebab-case](/docs/contributing/style-guide#file-names). +[file names are in kebab-case](../style-guide/#file-names). If this check fails, run `npm fix:filenames` locally and push the changes in a new commit. diff --git a/content/en/docs/contributing/prerequisites.md b/content/en/docs/contributing/prerequisites.md new file mode 100644 index 000000000000..db58db637de4 --- /dev/null +++ b/content/en/docs/contributing/prerequisites.md @@ -0,0 +1,43 @@ +--- +title: Prerequisites +description: + To contribute, you need to be familiar with the following techs and tools. +aliases: [requirements] +weight: 1 +--- + +To contribute to this repository, you need to be familiar with the following +techs and tools: + +- [git](https://git-scm.com/) +- [GitHub](https://github.com/) +- Markdown ([CommonMark](https://commonmark.org/)) +- YAML + +For technical details concerning how the documentation is built and tested +locally, see [Development](../development). + +## Sign the CNCF CLA {#cla} + +All OpenTelemetry contributors must sign the Linux Foundation [Contributor +License Agreement (CLA)][CLA]. + +Pull requests from contributors who haven't signed the CLA fail the automated +tests. The name and email you provide must match those found in your +`git config`, and your git name and email must match those used for the CNCF +CLA. + +## Code of conduct + +All OpenTelemetry contributors are bound by the [CNCF Community Code of +Conduct][CoC]. + +## Community guidelines + +For general OpenTelemetry community guidelines, including roles and +expectations, see [OpenTelemetry New Contributor Guide][NCG] + +[CLA]: https://docs.linuxfoundation.org/lfx/easycla/contributors +[CoC]: https://github.com/cncf/foundation/blob/main/code-of-conduct.md +[NCG]: + https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md diff --git a/content/en/docs/contributing/new-content.md b/content/en/docs/contributing/pull-requests.md similarity index 91% rename from content/en/docs/contributing/new-content.md rename to content/en/docs/contributing/pull-requests.md index dfb15fe53c59..e31df26d010f 100644 --- a/content/en/docs/contributing/new-content.md +++ b/content/en/docs/contributing/pull-requests.md @@ -1,22 +1,26 @@ --- -title: Add new content -description: Learn how to add new content using GitHub UI or a local fork. -weight: 2 +title: Submitting content +description: + Learn how to submit new or changed content using the GitHub UI or a local + fork. +aliases: [new-content] +weight: 15 --- -To contribute new content pages or improve existing content pages, open a pull -request (PR): +To contribute new or improve existing documentation content, submit a [pull +request][PR] (PR): -- If your change is small, or you're unfamiliar with Git, read +- If your change is small, or you're unfamiliar with Git, see [Changes using GitHub](#changes-using-github) to learn how to edit a page. -- If your changes are large, read [Work from a local fork](#fork-the-repo) to +- If your changes are large, see [Work from a local fork](#fork-the-repo) to learn how to make changes locally on your computer. -{{% alert title="Tip" %}} +{{% alert title="Tip: Draft status" %}} -Turn your pull request into a draft to signal that the content still isn't ready -for review. Maintainers may still comment or do high-level reviews, though they -won't review the content in full until you remove the draft status. +Set the status of your pull request to **Draft** to let maintainers know that +the content isn't ready for review yet. Maintainers may still comment or do +high-level reviews, though they won't review the content in full until you +remove the draft status. {{% /alert %}} @@ -46,7 +50,17 @@ _Figure 1. Contributing new content._ ## Changes using GitHub {#changes-using-github} If you're less experienced with Git workflows, here's an easier method of -opening a pull request. Figure 2 outlines the steps and the details follow. +creating and submitting a pull request. Figure 2 outlines the steps and the +details follow. + +{{% alert title="Contributor License Agreement (CLA)" color=warning %}} + +All contributors are required to [sign a Contributor License Agreement +(CLA)][CLA] before changes can be approved and merged. + +[CLA]: ../prerequisites/#cla + +{{% /alert %}} ```mermaid flowchart LR @@ -330,8 +344,7 @@ using [Netlify](https://www.netlify.com/). the OpenTelemetry website with your changes applied. This is how reviewers check your changes. -Other checks might also fail. See the -[list of all PR checks](/docs/contributing/pr-checks). +Other checks might also fail. See the [list of all PR checks](../pr-checks). ### Fix content issues automatically @@ -349,9 +362,8 @@ npm run test # Checks but does not update any files npm run fix:all # May update files ``` -To list available NPM scripts, run `npm run`. See -[PR checks](/docs/contributing/pr-checks) for more information on pull request -checks and how to fix errors automatically. +To list available NPM scripts, run `npm run`. See [PR checks](../pr-checks) for +more information on pull request checks and how to fix errors automatically. ### Preview your changes locally {#preview-locally} @@ -501,3 +513,4 @@ Pull requests are merged when they comply with the following criteria: [dashboard]: https://app.netlify.com/sites/opentelemetry/overview [deploy preview]: https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/ +[PR]: https://docs.github.com/en/pull-requests diff --git a/content/en/docs/contributing/requirements.md b/content/en/docs/contributing/requirements.md deleted file mode 100644 index 87e92d63a3b7..000000000000 --- a/content/en/docs/contributing/requirements.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Requirements -description: - To contribute, you need to be familiar with the following techs and tools. -weight: 1 ---- - -To contribute, you need to be familiar with the following techs and tools: - -- [git](https://git-scm.com/) -- [GitHub](https://github.com/) -- Markdown ([CommonMark](https://commonmark.org/)) -- YAML - -For technical details concerning how the documentation is built and tested -locally, see [Development](/docs/contributing/development). - -## Sign the CNCF CLA {#sign-the-cla} - -All OpenTelemetry contributors must read the -[Contributor guide](https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md) -and -[sign the Contributor License Agreement (CLA)](https://docs.linuxfoundation.org/lfx/easycla/contributors). - -Pull requests from contributors who haven't signed the CLA fail the automated -tests. The name and email you provide must match those found in your -`git config`, and your git name and email must match those used for the CNCF -CLA. - -## Code of conduct - -OpenTelemetry follows the -[CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). diff --git a/content/en/docs/contributing/style-guide.md b/content/en/docs/contributing/style-guide.md index 7438b97bc8dc..152605adc24c 100644 --- a/content/en/docs/contributing/style-guide.md +++ b/content/en/docs/contributing/style-guide.md @@ -22,8 +22,8 @@ before submitting a [pull request](https://docs.github.com/en/get-started/learning-about-github/github-glossary#pull-request) (PR), run `npm run fix:all` on your local machine and commit the changes. -If you run into errors or [failed PR checks](/docs/contributing/pr-checks), read -about our style guide and learn what you can do to fix certain common issues. +If you run into errors or [failed PR checks](../pr-checks), read about our style +guide and learn what you can do to fix certain common issues. {{% /alert %}} diff --git a/static/refcache.json b/static/refcache.json index 6d72ab661d7c..3171d96d7c52 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -2591,6 +2591,10 @@ "StatusCode": 206, "LastSeen": "2024-06-12T11:21:07.765039+02:00" }, + "https://docs.github.com/en/pull-requests": { + "StatusCode": 206, + "LastSeen": "2024-09-28T12:02:48.071874-04:00" + }, "https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests": { "StatusCode": 206, "LastSeen": "2024-01-30T15:25:17.633498-05:00" From 06c5930ac384bee4b78fd2766caa89ad17f5ccb4 Mon Sep 17 00:00:00 2001 From: ChrisTineo Date: Mon, 30 Sep 2024 07:58:59 -0400 Subject: [PATCH 07/21] Apply suggestions from code review Co-authored-by: Fabrizio Ferri-Benedetti --- content/es/docs/contributing/new-content.md | 110 +++++++++----------- 1 file changed, 49 insertions(+), 61 deletions(-) diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/new-content.md index 46f13259b891..512cbbeab0ac 100644 --- a/content/es/docs/contributing/new-content.md +++ b/content/es/docs/contributing/new-content.md @@ -8,18 +8,18 @@ default_lang_commit: f724c15be360e5059fb89e696d9a5cc8d00496f6 --- Para contribuir con nuevas páginas de contenido o mejorar las páginas de -contenido existentes, abra un Pull Request (PR): +contenido existentes, abre un Pull Request (PR): - Si tu cambio es pequeño, o ya estás familiarizado con Git, lee - [Realizando cambios con Github](#changes-using-github) para aprender a editar + [Editar con Github](#changes-using-github) para aprender a editar la página desde la interfaz de Github. -- Si tus cambio es mayor, lee [trabajando desde una rama local](#fork-the-repo) +- Si tus cambio es mayor, lee [Editar desde una rama local](#fork-the-repo) para aprender cómo realizar cambios localmente desde tu computadora. {{% alert title="Tip" %}} Convierte tu Pull Request en borrador para indicar que el contenido aún no está -listo para su revisión. Los encargados aún pueden comentar o realizar revisiones +listo para su revisión. Los miembros aún pueden comentar o realizar revisiones de alto nivel, aunque no revisarán el contenido en su totalidad hasta que indiques que ya no es un borrador. @@ -48,9 +48,9 @@ class first,second white _Figure 1. Contribuyendo con nuevo contenido._ -## Realizando cambios con Github {#changes-using-github} +## Editar con Github {#changes-using-github} -Si no tienes tanta experiencia con Git, aquí tienes un método más sencillo para +Si no tienes mucha experiencia con Git, aquí tienes un método más sencillo para abrir un Pull Request. La Figura 2 describe los pasos y los detalles a continuación. @@ -84,24 +84,24 @@ class id1 k8s _Figure 2. Pasos para abrir un Pull Request desde Github._ -1. En la página de la tarea en Github, haz click **Editar esta página** en el +1. En la página de la tarea en Github, selecciona **Editar esta página** en el panel de navegación en la derecha. 1. Si no eres miembro de este proyecto, puedes hacer fork al repositorio de - Github. Dando click en **Fork**. + Github. Selecciona **Fork**. 1. Haz tus cambios desde el editor de Github. 1. Llena el formulario de **Subir cambios**. -1. Haz click en **Proponer cambios**. +1. Selecciona en **Proponer cambios**. -1. Haz click en **Crear pull request**. +1. Selecciona en **Crear pull request**. 1. Cuando la pantalla de **Abrir un pull request** aparezca. Agrega una descripción para que los supervisores puedan comprender tus cambios. -1. Haz click en **Crear pull request**. +1.Selecciona en **Crear pull request**. Antes de hacer merge de tus cambios, Los miembros de la comunidad de OpenTelemetry harán revisión de tus cambios y los aprobarán. @@ -109,12 +109,12 @@ OpenTelemetry harán revisión de tus cambios y los aprobarán. Si un miembro te pide hacer cambios: 1. Ve a la pestaña de **Archivos cambiados**. -1. Haz click en el ícono del lápiz (Editar) en cualquiera de los archivos +1. Selecciona el icono del lápiz (Editar) en cualquiera de los archivos cambiados en tu pull request. 1. Haz los cambios solicitados. Si hay alguna sugerencia de código, aplícala. 1. Haz commit de tus cambios. -Cuando la revisión a terminado, un miemrbo de la comunidad hará merge de tu pull +Cuando la revisión a terminado, un miembro de la comunidad hará merge de tu pull request y tus cambios estarán disponibles al público en algunos minutos. {{% alert title="Tip" %}} @@ -124,12 +124,12 @@ revisión automática de formateo de tus cambios. {{% /alert %}} -## Trabajar desde una rama local {#fork-the-repo} +## Editar desde una rama local {#fork-the-repo} -Si eres un usuario más experimentado con Git, o tus cambios ameritan varios -archivos a la vez, preferirás trabajar desde una rama local. +Si eres un usuario más experimentado con Git, o tus cambios afectan varios +archivos a la vez, trabaja desde una rama local. -Asegurate de que tienes +Asegúrate de que tienes [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) instalado en tu computadora. También puedes usar una interfáz gráfica de Git. @@ -161,13 +161,13 @@ class S,T spacewhite class changes,changes2 white ``` -_Figure 3. Trabajando desde una rama local para hacer cambios._ +_Figura 3. Trabajando desde una rama local para hacer cambios._ ### Haz fork al repositorio de opentelemetry.io 1. Navega al repositorio [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) . -1. Haz click en **Fork**. +1. Selecciona **Fork**. ### Crea un clon local y agrega el upstream @@ -224,14 +224,14 @@ mantener tu copia local sincronizada con la versión en el repositorio original. 1. Haz tus cambios en tu editor de código favorito. -Regularmente, utiliza el comando `git status` para visualizar los archivos que -haz cambiado. +Usa el comando `git status` con regularidad para visualizar los archivos que +has cambiado. ### Haz commit de tus cambios Cuando estás listo para subir tu pull request, haz commit de tus cambios. -1. En tu repositorio local, revisa los cambios que necesitas hacer commit: +1. En tu repositorio local, revisa los cambios que quieres subir a GitHub: ```shell git status @@ -304,17 +304,17 @@ class 1,2,3,4,5,6,7,8 grey class first,second white ``` -\_Figure 4. Pasos para abrir un PR desde tu fork a +\_Figura 4. Pasos para abrir un PR desde tu fork a [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io). -1. En un navegador web, vaya al repositorio +1. En un navegador web, ve al repositorio [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io) . -1. Seleccione **Nuevo Pull Request**. -1. Seleccione **Comparar ramas**. -1. En el menú desplegable **repositorio principal**, seleccione su rama. -1. En el menú desplegable **Comparar**, seleccione tu rama. -1. Seleccione **Crear Pull Request**. -1. Agregue una descripción para tu pull request: +1. Selecciona **Nuevo Pull Request**. +1. Selecciona **Comparar ramas**. +1. En el menú desplegable **repositorio principal**, selecciona su rama. +1. En el menú desplegable **Comparar**, selecciona tu rama. +1. Selecciona **Crear Pull Request**. +1. Agrega una descripción para tu pull request: - **Título** (50 caracteres o menos): Resume la intención del cambio. - **Descripción**: Describe el cambio con más detalle. @@ -334,13 +334,13 @@ Tu pull request estará disponible en Después de abrir un PR, GitHub ejecuta pruebas automatizadas e intenta implementar una vista previa usando [Netlify](https://www.netlify.com/). -- Si la compilación de Netlify falla, seleccione **Detalles** para obtener más +- Si la compilación de Netlify falla, selecciona **Detalles** para obtener más información. -- Si la compilación de Netlify se realiza correctamente, seleccione **Detalles** +- Si la compilación de Netlify se realiza correctamente, selecciona **Detalles** para abrir una versión preparada del sitio web de OpenTelemetry con los cambios aplicados. Así es como los revisores verifican sus cambios. -También pueden fallar otras comprobaciones. Consulte la +También pueden fallar otras comprobaciones. Consulta la [lista de todas las comprobaciones de PR](/docs/contributing/pr-checks). ### Soluciona problemas de contenido automáticamente @@ -362,7 +362,7 @@ npm run fix:all # May update files ``` Para enumerar los scripts NPM disponibles, ejecuta `npm run`. Consulta -[Los pre-requisitos de PR](/docs/contributing/pr-checks) para obtener más +los [Pre-requisitos de PR](/docs/contributing/pr-checks) para obtener más información sobre las verificaciones de los Pull Request y cómo solucionar errores automáticamente. @@ -372,42 +372,42 @@ Obtén una vista previa de tus cambios localmente antes de enviarlos o abrir un pull request. Una vista previa te permite detectar errores de compilación o problemas de formato de Markdown. -Para crear y servir el sitio localmente con Hugo, ejecute el siguiente comando: +Para crear y servir el sitio localmente con Hugo, ejecuta el siguiente comando: ```shell npm run serve ``` -Navegue a `http://localhost:1313` en su navegador web para ver la vista previa +Navega a `http://localhost:1313` en su navegador web para ver la vista previa local. Hugo observa los cambios y reconstruye el sitio según sea necesario. -Para detener la instancia local de Hugo, vuelva a la terminal y escriba +Para detener la instancia local de Hugo, vuelve a la terminal y escriba `Ctrl+C`, o cierre la ventana de la terminal. ### Implementaciones del sitio y vistas previas de PR -Si envía una PR, Netlify crea una [Vista Previa de Implementación][] para que pueda +Si envías una PR, Netlify crea una [Vista Previa de Implementación][] para que puedas revisar sus cambios. Una vez que se fusiona su PR, Netlify implementa el sitio actualizado en el servidor de producción. > **Nota**: Las vistas previas de PR incluyen _páginas de borrador_, pero las > compilaciones de producción no. -Para ver los registros de implementación y más, visite el [Panel de Control][] -del proyecto -- Se requiere inicio de sesión en Netlify. +Para ver los registros de implementación y más, visita el [Panel de Control][] +del proyecto. Se requiere inicio de sesión en Netlify. ### Pautas de PR Antes de fusionar un PR, a veces se requieren algunas iteraciones de revisión y -edición. Para ayudarnos a nosotros y a usted mismo a hacer que este proceso sea -lo más sencillo posible, le pedimos que respete lo siguiente: +edición. Para ayudarnos a nosotros y a ti mismo a hacer que este proceso sea +lo más sencillo posible, te pedimos que respetes lo siguiente: -- Si su PR no es una solución rápida, entonces **trabaje desde una copia**: haga - clic en el botón +- Si su PR no es una solución rápida, entonces **trabaja desde una copia**: + selecciona el botón [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) en la parte superior del repositorio y clone el repositorio localmente. Cuando esté listo, genere un PR al repositorio original. -- **No trabaje desde la rama `main`** de su fork, sino que cree una rama +- **No trabajes desde la rama `main`** de su fork: crea una rama específica para el PR. - Asegúrate de que los mantenedores tengan permiso para aplicar cambios a tu solicitud de incorporación de cambios @@ -415,7 +415,7 @@ lo más sencillo posible, le pedimos que respete lo siguiente: ### Cambios de los revisores -A veces, los revisores se suben cambios en tu pull request. Antes de realizar +A veces, los revisores suben cambios en tu pull request. Antes de realizar cualquier otro cambio, actualiza tu rama. 1. Actualiza los commits de tu fork y haz rebase de tu rama actual: @@ -437,7 +437,7 @@ GitHub. ### Conflictos en ramas y git rebase Si otro colaborador realiza cambios en el mismo archivo en otro pull request, -puede crear un merge. Es tu responsabilidad resolver todos los conflictos en tu +puedes crear un merge. Es tu responsabilidad resolver todos los conflictos en tu Pull Request. 1. Actualiza tu fork y haz git rebase de tu rama local: @@ -472,25 +472,13 @@ Pull Request. 1. Abra cada archivo en conflicto y busque los marcadores de conflicto: `>>>`, `<<<`, y `===`. Resuelva el conflicto y elimine el marcador de conflicto. -Para obtener más información, consulte +Para obtener más información, consulta [Cómo se presentan los conflictos](https://git-scm.com/docs/git-merge#_how_conflicts_are_presented). -1. Agregue los archivos al conjunto de cambios: +1. Agrega los archivos al conjunto de cambios: ```shell git add - ``` - -1. Continúe con el rebase: - - ```shell - git rebase --continue - ``` - -1. Repita los pasos 2 a 5 según sea necesario. - - Después de aplicar todas las confirmaciones, el comando `git status` muestra - que el rebase está completo. 1. Haz force push de los cambios en tu rama a tu fork: From ff9c04a3aa873dc5375a8666fa2f85d707991d84 Mon Sep 17 00:00:00 2001 From: ChrisTineo Date: Mon, 30 Sep 2024 08:00:40 -0400 Subject: [PATCH 08/21] chore: replace empaqueta to compila --- content/es/docs/contributing/new-content.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/new-content.md index 512cbbeab0ac..feccb2eb2ce5 100644 --- a/content/es/docs/contributing/new-content.md +++ b/content/es/docs/contributing/new-content.md @@ -32,7 +32,7 @@ flowchart LR subgraph first[Cómo contribuir] direction TB T[ ] -.- - B[Haz un fork al repo de Github] --- C[Escribe el nuevo contenido utilizando Markdown
y empaqueta la página web en Hugo] + B[Haz un fork al repo de Github] --- C[Escribe el nuevo contenido utilizando Markdown
y compila la página web en Hugo] C --- D[Sube tus cambios locales al Fork] D --- E[Abre un Pull Request] E --- F[Firma el CNCF CLA] From b9d61b205fec28dbccad16291b0c7cc4b4818da7 Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Mon, 30 Sep 2024 11:29:42 -0400 Subject: [PATCH 09/21] Revert "fix: :bug: remove markdown list enumerator to display content in mermaid chart" This reverts commit 286225b017a79df149cd7849a81124f8f0f8ad52. --- content/en/docs/contributing/pull-requests.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/en/docs/contributing/pull-requests.md b/content/en/docs/contributing/pull-requests.md index b7ea1f073e5e..ac831674f9c7 100644 --- a/content/en/docs/contributing/pull-requests.md +++ b/content/en/docs/contributing/pull-requests.md @@ -68,14 +68,14 @@ A([fa:fa-user New
Contributor]) --- id1[(open-telemetry/opentelemetry.io
G subgraph tasks[Changes using GitHub] direction TB 0[ ] -.- - 1[Edit this page] --> 2[Use GitHub markdown
editor to make changes] - 2 --> 3[fill in Propose file change] + 1[1. Edit this page] --> 2[2. Use GitHub markdown
editor to make changes] + 2 --> 3[3. fill in Propose file change] end subgraph tasks2[ ] direction TB - 4[select Propose file change] --> 5[select Create pull request] --> 6[fill in Open a pull request] - 6 --> 7[select Create pull request] +4[4. select Propose file change] --> 5[5. select Create pull request] --> 6[6. fill in Open a pull request] +6 --> 7[7. select Create pull request] end id1 --> tasks --> tasks2 @@ -289,15 +289,15 @@ Figure 4 shows the steps to open a PR from your fork to flowchart LR subgraph first[ ] direction TB -1[Go to opentelemetry.io repository] --> 2[Select New Pull Request] -2 --> 3[Select compare across forks] -3 --> 4[Select your fork from
head repository drop-down menu] +1[1. Go to opentelemetry.io repository] --> 2[2. Select New Pull Request] +2 --> 3[3. Select compare across forks] +3 --> 4[4. Select your fork from
head repository drop-down menu] end subgraph second [ ] direction TB -5[Select your branch from
the compare drop-down menu] --> 6[Select Create Pull Request] -6 --> 7[Add a description
to your PR] -7 --> 8[Select Create pull request] +5[5. Select your branch from
the compare drop-down menu] --> 6[6. Select Create Pull Request] +6 --> 7[7. Add a description
to your PR] +7 --> 8[8. Select Create pull request] end first --> second From 8a653c260c0bc1bc5a5e39d7e7c3235fef1a6ae5 Mon Sep 17 00:00:00 2001 From: ChrisTineo Date: Mon, 30 Sep 2024 11:31:34 -0400 Subject: [PATCH 10/21] Apply suggestions from code review Co-authored-by: Fabrizio Ferri-Benedetti --- content/es/docs/contributing/new-content.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/new-content.md index feccb2eb2ce5..a8175ab3a489 100644 --- a/content/es/docs/contributing/new-content.md +++ b/content/es/docs/contributing/new-content.md @@ -94,14 +94,14 @@ _Figure 2. Pasos para abrir un Pull Request desde Github._ 1. Llena el formulario de **Subir cambios**. -1. Selecciona en **Proponer cambios**. +1. Selecciona **Proponer cambios**. -1. Selecciona en **Crear pull request**. +1. Selecciona **Crear pull request**. 1. Cuando la pantalla de **Abrir un pull request** aparezca. Agrega una descripción para que los supervisores puedan comprender tus cambios. -1.Selecciona en **Crear pull request**. +1.Selecciona **Crear pull request**. Antes de hacer merge de tus cambios, Los miembros de la comunidad de OpenTelemetry harán revisión de tus cambios y los aprobarán. From ec0561b2f8a23c20b91f0beec488928d1676037e Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Mon, 30 Sep 2024 11:39:39 -0400 Subject: [PATCH 11/21] docs: :memo: rename new content docs to pull-requests.md --- .../{new-content.md => pull-requests.md} | 46 ++++++++++--------- 1 file changed, 24 insertions(+), 22 deletions(-) rename content/es/docs/contributing/{new-content.md => pull-requests.md} (95%) diff --git a/content/es/docs/contributing/new-content.md b/content/es/docs/contributing/pull-requests.md similarity index 95% rename from content/es/docs/contributing/new-content.md rename to content/es/docs/contributing/pull-requests.md index a8175ab3a489..9f5e970a7085 100644 --- a/content/es/docs/contributing/new-content.md +++ b/content/es/docs/contributing/pull-requests.md @@ -11,10 +11,10 @@ Para contribuir con nuevas páginas de contenido o mejorar las páginas de contenido existentes, abre un Pull Request (PR): - Si tu cambio es pequeño, o ya estás familiarizado con Git, lee - [Editar con Github](#changes-using-github) para aprender a editar - la página desde la interfaz de Github. -- Si tus cambio es mayor, lee [Editar desde una rama local](#fork-the-repo) - para aprender cómo realizar cambios localmente desde tu computadora. + [Editar con GitHub](#changes-using-github) para aprender a editar la página + desde la interfaz de GitHub. +- Si tus cambio es mayor, lee [Editar desde una rama local](#fork-the-repo) para + aprender cómo realizar cambios localmente desde tu computadora. {{% alert title="Tip" %}} @@ -32,7 +32,7 @@ flowchart LR subgraph first[Cómo contribuir] direction TB T[ ] -.- - B[Haz un fork al repo de Github] --- C[Escribe el nuevo contenido utilizando Markdown
y compila la página web en Hugo] + B[Haz un fork al repo de GitHub] --- C[Escribe el nuevo contenido utilizando Markdown
y compila la página web en Hugo] C --- D[Sube tus cambios locales al Fork] D --- E[Abre un Pull Request] E --- F[Firma el CNCF CLA] @@ -48,7 +48,7 @@ class first,second white _Figure 1. Contribuyendo con nuevo contenido._ -## Editar con Github {#changes-using-github} +## Editar con GitHub {#changes-using-github} Si no tienes mucha experiencia con Git, aquí tienes un método más sencillo para abrir un Pull Request. La Figura 2 describe los pasos y los detalles a @@ -57,10 +57,10 @@ continuación. ```mermaid flowchart LR A([fa:fa-user Nuevo
Contribuyente]) --- id1[(open-telemetry/opentelemetry.io
GitHub)] -subgraph tasks[Editando en Github] +subgraph tasks[Editando en GitHub] direction TB 0[ ] -.- - 1[Edita esta página] --> 2[Usa el editor de markdown en Github
para hacer tus cambios] + 1[Edita esta página] --> 2[Usa el editor de markdown en GitHub
para hacer tus cambios] 2 --> 3[agrega tus propuesta de cambios] end @@ -82,15 +82,15 @@ class tasks,tasks2 white class id1 k8s ``` -_Figure 2. Pasos para abrir un Pull Request desde Github._ +_Figure 2. Pasos para abrir un Pull Request desde GitHub._ -1. En la página de la tarea en Github, selecciona **Editar esta página** en el +1. En la página de la tarea en GitHub, selecciona **Editar esta página** en el panel de navegación en la derecha. 1. Si no eres miembro de este proyecto, puedes hacer fork al repositorio de - Github. Selecciona **Fork**. + GitHub. Selecciona **Fork**. -1. Haz tus cambios desde el editor de Github. +1. Haz tus cambios desde el editor de GitHub. 1. Llena el formulario de **Subir cambios**. @@ -167,7 +167,7 @@ _Figura 3. Trabajando desde una rama local para hacer cambios._ 1. Navega al repositorio [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) . -1. Selecciona **Fork**. +1. Selecciona **Fork**. ### Crea un clon local y agrega el upstream @@ -224,8 +224,8 @@ mantener tu copia local sincronizada con la versión en el repositorio original. 1. Haz tus cambios en tu editor de código favorito. -Usa el comando `git status` con regularidad para visualizar los archivos que -has cambiado. +Usa el comando `git status` con regularidad para visualizar los archivos que has +cambiado. ### Haz commit de tus cambios @@ -361,8 +361,8 @@ npm run test # Checks but does not update any files npm run fix:all # May update files ``` -Para enumerar los scripts NPM disponibles, ejecuta `npm run`. Consulta -los [Pre-requisitos de PR](/docs/contributing/pr-checks) para obtener más +Para enumerar los scripts NPM disponibles, ejecuta `npm run`. Consulta los +[Pre-requisitos de PR](/docs/contributing/pr-checks) para obtener más información sobre las verificaciones de los Pull Request y cómo solucionar errores automáticamente. @@ -399,16 +399,16 @@ del proyecto. Se requiere inicio de sesión en Netlify. ### Pautas de PR Antes de fusionar un PR, a veces se requieren algunas iteraciones de revisión y -edición. Para ayudarnos a nosotros y a ti mismo a hacer que este proceso sea -lo más sencillo posible, te pedimos que respetes lo siguiente: +edición. Para ayudarnos a nosotros y a ti mismo a hacer que este proceso sea lo +más sencillo posible, te pedimos que respetes lo siguiente: -- Si su PR no es una solución rápida, entonces **trabaja desde una copia**: +- Si su PR no es una solución rápida, entonces **trabaja desde una copia**: selecciona el botón [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) en la parte superior del repositorio y clone el repositorio localmente. Cuando esté listo, genere un PR al repositorio original. -- **No trabajes desde la rama `main`** de su fork: crea una rama - específica para el PR. +- **No trabajes desde la rama `main`** de su fork: crea una rama específica para + el PR. - Asegúrate de que los mantenedores tengan permiso para aplicar cambios a tu solicitud de incorporación de cambios (https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). @@ -480,6 +480,8 @@ Para obtener más información, consulta ```shell git add + ``` + 1. Haz force push de los cambios en tu rama a tu fork: ```shell From 4e7d1fb7d65ab8d3f45653876064b2c0cfb74bf7 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 1 Oct 2024 07:54:31 +0200 Subject: [PATCH 12/21] Update pull-requests.md --- content/es/docs/contributing/pull-requests.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/es/docs/contributing/pull-requests.md b/content/es/docs/contributing/pull-requests.md index 9f5e970a7085..b401f38d54c4 100644 --- a/content/es/docs/contributing/pull-requests.md +++ b/content/es/docs/contributing/pull-requests.md @@ -5,6 +5,7 @@ description: localmente. weight: 2 default_lang_commit: f724c15be360e5059fb89e696d9a5cc8d00496f6 +cSpell:ignore: aplícala vincúlalos solucionándolas --- Para contribuir con nuevas páginas de contenido o mejorar las páginas de @@ -131,7 +132,7 @@ archivos a la vez, trabaja desde una rama local. Asegúrate de que tienes [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) instalado -en tu computadora. También puedes usar una interfáz gráfica de Git. +en tu computadora. También puedes usar una interfaz gráfica de Git. La figura 3 muestra los pasos a seguir cuando se trabaja desde una rama local. A continuación se detallan los pasos. From 68b0c1739d8306de7a0f459910335f844ccbac0e Mon Sep 17 00:00:00 2001 From: Christopher Tineo Date: Tue, 1 Oct 2024 07:33:15 -0400 Subject: [PATCH 13/21] Revert "Merge branch 'main' into docs/es/contributing-new-content" This reverts commit 241e6df9b163a4ef04b85cd13999e0ff4ebca254, reversing changes made to cfb4a4666faa718ff4aa9f27747e8b9dc32e4c18. --- .htmltest.yml | 1 - content/en/api-docs.md | 15 +++++++++++++++ content/en/api.md | 8 -------- content/en/docs/languages/_index.md | 4 ++-- 4 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 content/en/api-docs.md delete mode 100644 content/en/api.md diff --git a/.htmltest.yml b/.htmltest.yml index 1b7ee42e6d13..755573156871 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -12,7 +12,6 @@ IgnoreDirs: - zh/docs/contributing/pr-checks IgnoreInternalURLs: # list of paths IgnoreURLs: # list of regexs of paths or URLs to be ignored - - ^/api$ - ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$ - ^(/..)?/docs/collector/registry/$ - ^(/..)?/docs/languages/net/(metrics-api|traces-api)/ diff --git a/content/en/api-docs.md b/content/en/api-docs.md new file mode 100644 index 000000000000..0c032a0b2a02 --- /dev/null +++ b/content/en/api-docs.md @@ -0,0 +1,15 @@ +--- +title: API Documentation +linkTitle: Docs +--- + +{{% blocks/section color="white" %}} + +## {{% param title %}} + +Below you will find links to all the API references available for the different +implementations of the OpenTelemetry API & SDK + +{{% apidocs %}} + +{{% /blocks/section %}} diff --git a/content/en/api.md b/content/en/api.md deleted file mode 100644 index 6459b6dda3d0..000000000000 --- a/content/en/api.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: API references -linkTitle: API -redirect: /docs/languages/#api-references -manualLinkTarget: _blank -_build: { render: link } -aliases: [api-docs] ---- diff --git a/content/en/docs/languages/_index.md b/content/en/docs/languages/_index.md index 87d3f873946a..d25011f7cc33 100644 --- a/content/en/docs/languages/_index.md +++ b/content/en/docs/languages/_index.md @@ -48,9 +48,9 @@ references are available: {{% apidocs %}} -{{% alert title="Note" color="info" %}} +{{% alert title="Tip" color="info" %}} -The list above is aliased to [`/api`](/api). +You can find a list of available API references at . {{% /alert %}} From 4e42f6054ef7e1e6d13414f70ac55782e654c38c Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 1 Oct 2024 13:38:13 +0200 Subject: [PATCH 14/21] Update content/es/docs/contributing/pull-requests.md Co-authored-by: Patrice Chalin --- content/es/docs/contributing/pull-requests.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/es/docs/contributing/pull-requests.md b/content/es/docs/contributing/pull-requests.md index b401f38d54c4..4ce0bceafc3e 100644 --- a/content/es/docs/contributing/pull-requests.md +++ b/content/es/docs/contributing/pull-requests.md @@ -480,7 +480,6 @@ Para obtener más información, consulta ```shell git add - ``` 1. Haz force push de los cambios en tu rama a tu fork: From af6c6ba638c80202ea85e9e5d5d3a8d2dc96de3d Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 1 Oct 2024 13:38:19 +0200 Subject: [PATCH 15/21] Update content/es/docs/contributing/pull-requests.md Co-authored-by: Patrice Chalin --- content/es/docs/contributing/pull-requests.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/es/docs/contributing/pull-requests.md b/content/es/docs/contributing/pull-requests.md index 4ce0bceafc3e..5263b1df9a1f 100644 --- a/content/es/docs/contributing/pull-requests.md +++ b/content/es/docs/contributing/pull-requests.md @@ -410,9 +410,8 @@ más sencillo posible, te pedimos que respetes lo siguiente: genere un PR al repositorio original. - **No trabajes desde la rama `main`** de su fork: crea una rama específica para el PR. -- Asegúrate de que los mantenedores tengan permiso para aplicar cambios a tu - solicitud de incorporación de cambios - (https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). +- Asegúrate de que los mantenedores tengan permiso para [aplicar cambios a tu + solicitud de incorporación de cambios](https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). ### Cambios de los revisores From eeaa0b4853765465dba1910af89e1536cb5ac13b Mon Sep 17 00:00:00 2001 From: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Date: Tue, 1 Oct 2024 11:40:03 +0000 Subject: [PATCH 16/21] Results from /fix:format --- content/es/docs/contributing/pull-requests.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/es/docs/contributing/pull-requests.md b/content/es/docs/contributing/pull-requests.md index 5263b1df9a1f..6b661ae93d4c 100644 --- a/content/es/docs/contributing/pull-requests.md +++ b/content/es/docs/contributing/pull-requests.md @@ -410,8 +410,8 @@ más sencillo posible, te pedimos que respetes lo siguiente: genere un PR al repositorio original. - **No trabajes desde la rama `main`** de su fork: crea una rama específica para el PR. -- Asegúrate de que los mantenedores tengan permiso para [aplicar cambios a tu - solicitud de incorporación de cambios](https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). +- Asegúrate de que los mantenedores tengan permiso para + [aplicar cambios a tu solicitud de incorporación de cambios](https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). ### Cambios de los revisores From 50b579b89388d12678099a4cc5f4789f9ddb2448 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Tue, 1 Oct 2024 13:53:31 +0200 Subject: [PATCH 17/21] Add hash --- content/es/docs/contributing/pull-requests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/es/docs/contributing/pull-requests.md b/content/es/docs/contributing/pull-requests.md index 6b661ae93d4c..4cbadfb53954 100644 --- a/content/es/docs/contributing/pull-requests.md +++ b/content/es/docs/contributing/pull-requests.md @@ -344,7 +344,7 @@ implementar una vista previa usando [Netlify](https://www.netlify.com/). También pueden fallar otras comprobaciones. Consulta la [lista de todas las comprobaciones de PR](/docs/contributing/pr-checks). -### Soluciona problemas de contenido automáticamente +### Soluciona problemas de contenido automáticamente {#fix-content-issues-automatically} Antes de enviar un cambio al repositorio, ejecuta el siguiente comando y (i) aborda los problemas informados, (ii) confirma los archivos modificados por el From 03ce062d98074cba5076d16239018df1e4da0e15 Mon Sep 17 00:00:00 2001 From: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Date: Tue, 1 Oct 2024 12:03:01 +0000 Subject: [PATCH 18/21] Results from /fix:refcache --- static/refcache.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/static/refcache.json b/static/refcache.json index 7d0ee2af33b6..63d5f9bfb9c5 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -2611,6 +2611,10 @@ "StatusCode": 206, "LastSeen": "2024-06-12T11:21:20.570863+02:00" }, + "https://docs.github.com/es/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork": { + "StatusCode": 206, + "LastSeen": "2024-10-01T12:01:34.151955277Z" + }, "https://docs.google.com/document/d/1-23Sf7-xZK3OL5Ogv2pK0NP9YotlSa0PKU9bvvtQwp8": { "StatusCode": 200, "LastSeen": "2024-08-15T15:44:20.868165+02:00" From ca62e223ad4b4e63753b66519d7dbef8be78e520 Mon Sep 17 00:00:00 2001 From: Gerardo Lopez <143828508+falconcr@users.noreply.github.com> Date: Tue, 1 Oct 2024 10:03:58 -0600 Subject: [PATCH 19/21] feat: [es] Create docs/kubernetes/collector/components.md (#5263) Signed-off-by: Gerardo Lopez Co-authored-by: Fabrizio Ferri-Benedetti Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> --- .../docs/kubernetes/collector/components.md | 826 ++++++++++++++++++ 1 file changed, 826 insertions(+) create mode 100644 content/es/docs/kubernetes/collector/components.md diff --git a/content/es/docs/kubernetes/collector/components.md b/content/es/docs/kubernetes/collector/components.md new file mode 100644 index 000000000000..79b37eb71406 --- /dev/null +++ b/content/es/docs/kubernetes/collector/components.md @@ -0,0 +1,826 @@ +--- +title: Componentes clave para Kubernetes +linkTitle: Componentes +# prettier-ignore +cSpell:ignore: alertmanagers containerd crio filelog gotime horizontalpodautoscalers hostfs hostmetrics iostream k8sattributes kubelet kubeletstats logtag replicasets replicationcontrollers resourcequotas statefulsets varlibdockercontainers varlogpods asignador paginación +default_lang_commit: 3815d1481fe753df10ea3dc26cbe64dba0230579 +--- + +El [OpenTelemetry Collector](/docs/collector/) admite numerosos receptores y +procesadores diferentes para facilitar la supervisión de Kubernetes. Esta +sección describe los componentes más importantes para recopilar datos de +Kubernetes y mejorarlos. + +Componentes incluidos en esta página: + +- [Procesador de atributos de Kubernetes](#kubernetes-attributes-processor): + agrega metadatos de Kubernetes a la telemetría de la aplicación entrante. +- [Receptor de estadísticas de Kubelet](#kubeletstats-receiver): extrae métricas + de nodos, pods y contenedores del servidor API en un kubelet. +- [Receptor de logs de archivos](#filelog-receiver): recopila logs de Kubernetes + y logs de aplicaciones escritos en stdout/stderr. +- [Receptor de clúster de Kubernetes](#kubernetes-cluster-receiver): recopila + métricas a nivel de clúster y eventos de entidad. +- [Receptor de objetos de Kubernetes](#kubernetes-objects-receiver): recopila + objetos, como eventos, del servidor API de Kubernetes. +- [Receptor Prometheus](#prometheus-receiver): recibe métricas en formato + [Prometheus](https://prometheus.io/). +- [Receptor de métricas del host](#host-metrics-receiver): extrae métricas del + host de nodos de Kubernetes. + +Para los logs, las métricas o los rastros de aplicaciones, recomendamos el +[receptor OTLP](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver), +pero cualquier receptor que se ajuste a sus datos es adecuado. + +## Procesador de atributos de Kubernetes {#kubernetes-attributes-processor} + +| Patrón de implementación | Utilizable | +| ------------------------ | ---------- | +| DaemonSet (agente) | Sí | +| Deployment (gateway) | Sí | +| Sidecar | No | + +El procesador de atributos de Kubernetes descubre automáticamente los pods de +Kubernetes, extrae sus metadatos y agrega los metadatos extraídos a intervalos, +métricas y logs como atributos de recursos. + +**El procesador de atributos de Kubernetes es uno de los componentes más +importantes para un recopilador que se ejecuta en Kubernetes. Cualquier +recopilador que reciba datos de la aplicación debe usarlo.** Debido a que agrega +contexto de Kubernetes a su telemetría, el procesador de atributos de Kubernetes +le permite correlacionar los rastros, las métricas y los logs de de su +aplicación con su telemetría de Kubernetes, como las métricas de pod y los +rastros. + +El procesador de atributos de Kubernetes utiliza la API de Kubernetes para +descubrir todos los pods que se ejecutan en un clúster y mantiene un registro de +sus direcciones IP, UID de pod y metadatos interesantes. De manera +predeterminada, los datos que pasan por el procesador se asocian a un pod a +través de la dirección IP de la solicitud entrante, pero se pueden configurar +diferentes reglas. Dado que el procesador utiliza la API de Kubernetes, requiere +permisos especiales (consulta el ejemplo a continuación). Si está utilizando el +[gráfico Helm de OpenTelemetry Collector](../../helm/collector/), puede usar el +[ajuste preestablecido `kubernetesAttributes`](../../helm/collector/#kubernetes-attributes-preset) +para comenzar. + +Los siguientes atributos se agregan de forma predeterminada: + +- `k8s.namespace.name` +- `k8s.pod.name` +- `k8s.pod.uid` +- `k8s.pod.start_time` +- `k8s.deployment.name` +- `k8s.node.name` + +El procesador de atributos de Kubernetes también puede establecer atributos de +recursos personalizados para rastreos, métricas y logs mediante las etiquetas y +anotaciones de Kubernetes que haya agregado a sus pods y espacios de nombres. + +```yaml +k8sattributes: + auth_type: 'serviceAccount' + extract: + metadata: # extraído del pod + - k8s.namespace.name + - k8s.pod.name + - k8s.pod.start_time + - k8s.pod.uid + - k8s.deployment.name + - k8s.node.name + annotations: + # Extrae el valor de una anotación del pod con la clave `annotation-one` y lo inserta como un atributo de recurso con la clave `a1` + - tag_name: a1 + key: annotation-one + from: pod + # Extrae el valor de una anotación del namespace con la clave `annotation-two` utilizando una expresión regular y lo inserta como un recurso con la clave `a2` + - tag_name: a2 + key: annotation-two + regex: field=(?P.+) + from: namespace + labels: + # Extrae el valor de una etiqueta del namespace con la clave `label1` y lo inserta como un atributo de recurso con la clave `l1` + - tag_name: l1 + key: label1 + from: namespace + # Extrae el valor de una etiqueta del pod con la clave `label2` utilizando una expresión regular y lo inserta como un atributo de recurso con la clave `l2` + - tag_name: l2 + key: label2 + regex: field=(?P.+) + from: pod + pod_association: # Cómo asociar los datos a un pod (el orden importa) + - sources: # Primero intenta usar el valor del atributo de recurso k8s.pod.ip + - from: resource_attribute + name: k8s.pod.ip + - sources: # Luego intenta usar el valor del atributo de recurso k8s.pod.uid + - from: resource_attribute + name: k8s.pod.uid + - sources: # Si ninguno de esos funciona, usa la conexión de la solicitud para obtener la IP del pod. + - from: connection +``` + +También hay opciones de configuración especiales para cuando el recopilador se +implementa como un DaemonSet de Kubernetes (agente) o como una implementación de +Kubernetes (gateway). Para obtener más detalles, consulta +[Escenarios de implementación](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor#deployment-scenarios) + +Para conocer los detalles de configuración del procesador de atributos de +Kubernetes, consulta +[Procesador de atributos de Kubernetes](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor). + +Dado que el procesador usa la API de Kubernetes, necesita el permiso correcto +para funcionar correctamente. Para la mayoría de los casos de uso, debe otorgar +a la cuenta de servicio que ejecuta el recopilador los siguientes permisos a +través de un ClusterRole. + +```yaml +apiVersion: v1 +kind: ServiceAccount +metadata: + name: collector + namespace: +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: otel-collector +rules: + - apiGroups: + - '' + resources: + - 'pods' + - 'namespaces' + verbs: + - 'get' + - 'watch' + - 'list' + - apiGroups: + - 'apps' + resources: + - 'replicasets' + verbs: + - 'get' + - 'list' + - 'watch' + - apiGroups: + - 'extensions' + resources: + - 'replicasets' + verbs: + - 'get' + - 'list' + - 'watch' +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: otel-collector +subjects: + - kind: ServiceAccount + name: collector + namespace: +roleRef: + kind: ClusterRole + name: otel-collector + apiGroup: rbac.authorization.k8s.io +``` + +## Receptor de Kubeletstats {#kubeletstats-receiver} + +| Patrón de implementación | Utilizable | +| ------------------------ | ---------------------------------------------------------------------- | +| DaemonSet (agente) | Preferido | +| Deployment (gateway) | Sí, pero solo recopilará métricas del nodo en el que está implementado | +| Sidecar | No | + +Cada nodo de Kubernetes ejecuta un kubelet que incluye un servidor API. Los +Kubernetes El receptor se conecta a ese kubelet a través del servidor API para +recopilar métricas sobre el nodo y las cargas de trabajo que se ejecutan en el +nodo. + +Existen diferentes métodos de autenticación, pero normalmente una cuenta de +servicio se utiliza. La cuenta de servicio también necesitará los permisos +adecuados para extraer datos de el Kubelet (ver más abajo). Si estás usando el +[Gráfico de timón de OpenTelemetry Collector](../../helm/collector/) puede +utilizar el +[`kubeletMetrics` preset](../../helm/collector/#kubelet-metrics-preset) para +empezar. + +De forma predeterminada, se recopilan métricas para pods y nodos, pero también +se puede configurar el receptor para recopilar las métricas del contenedor y el +volumen. El receptor también permite configurar con qué frecuencia se recopilan +las métricas: + +```yaml +receivers: + kubeletstats: + collection_interval: 10s + auth_type: 'serviceAccount' + endpoint: '${env:K8S_NODE_NAME}:10250' + insecure_skip_verify: true + metric_groups: + - node + - pod + - container +``` + +Para obtener detalles específicos sobre qué métricas se recopilan, consulta +[Métricas predeterminadas](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/kubeletsstatsreceiver/documentation.md). +Para obtener detalles de configuración específicos, consulta +[Receptor de Kubeletstats](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/kubeletstatsreceiver). + +Dado que el procesador usa la API de Kubernetes, necesitas el permiso correcto +para funcionar correctamente. Para la mayoría de los casos de uso, debes otorgar +a la cuenta de servicio que ejecuta el recopilador los siguientes permisos a +través de un ClusterRole. + +```yaml +--- +apiVersion: v1 +kind: ServiceAccount +metadata: + name: otel-collector +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + name: otel-collector +rules: + - apiGroups: [''] + resources: ['nodes/stats'] + verbs: ['get', 'watch', 'list'] +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: otel-collector +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: otel-collector +subjects: + - kind: ServiceAccount + name: otel-collector + namespace: default +``` + +## Receptor de logs de archivos {#filelog-receiver} + +| Patrón de implementación | Utilizable | +| ------------------------ | -------------------------------------------------------------- | +| DaemonSet (agente) | Preferido | +| Deployment (gateway) | Sí, pero solo recopilará logs del nodo en el que se implementa | +| Sidecar | Sí, pero esto se consideraría una configuración avanzada | + +El receptor de logs de archivos rastrea y analiza los logs de los archivos. +Aunque no es un receptor específico de Kubernetes, sigue siendo la solución de +facto para recopilar cualquier registro de Kubernetes. + +El receptor de Filelog está compuesto por operadores que se encadenan entre sí +para procesar un registro. Cada operador realiza una responsabilidad simple, +como analizar una marca de tiempo o JSON. Configurar un receptor de Filelog no +es trivial. Si está usando el +[diagrama de Helm de OpenTelemetry Collector](../../helm/collector/) puede usar +el +[ajuste preestablecido `logsCollection`](../../helm/collector/#logs-collection-preset) +para comenzar. + +Dado que los logs de Kubernetes normalmente se ajustan a un conjunto de formatos +estándar, una configuración típica de receptor de Filelog para Kubernetes se ve +así: + +```yaml +filelog: + include: + - /var/log/pods/*/*/*.log + exclude: + # Exclude logs from all containers named otel-collector + - /var/log/pods/*/otel-collector/*.log + start_at: beginning + include_file_path: true + include_file_name: false + operators: + # Find out which format is used by kubernetes + - type: router + id: get-format + routes: + - output: parser-docker + expr: 'body matches "^\\{"' + - output: parser-crio + expr: 'body matches "^[^ Z]+ "' + - output: parser-containerd + expr: 'body matches "^[^ Z]+Z"' + # Parse CRI-O format + - type: regex_parser + id: parser-crio + regex: + '^(?P