Contribuir a la documentación de Kubernetes

Kubernetes v1.15 ya no mantiene activamente la documentación. La versión que está viendo actualmente es una instantánea estática. Para la documentación actualizada, visita la última versión.

Kubernetes es posible gracias a la participación de la comunidad y la documentación es vital para facilitar el acceso al proyecto.

Cualquiera puede contribuir en el proyecto de Kubernetes, tanto si acabas de descubrir la plataforma como si lleves años involucrado. Tampoco importa si eres desarrollador, usuario final o alguien que simplemente no soporta ver errores tipográficos. ¡Cualquier contribución será bien recibida!

Para conocer más formas de involucrarse en la comunidad de Kubernetes o de aprender sobre nosotros, visite la sección comunidad de Kubernetes.

Para obtener información cómo escribir documentación de Kubernetes, consulte la guía de estilo.

Tipos de contribuidores

Kubernetes Member, un miembro de la organziación de Kubernetes que ha firmado el CLA y contribuido al projecto. Puedes consultar más información en el documento sobre los requisitos para ser miembro de Kubernetes en el documento Community membership.

SIG Docs reviewer, un revisor del grupo de interés de documentación es un miembro de la organización Kubernetes que tiene interés en revisar las pull requests relacionadas con el site y la documentación. Para poder ser revisor, un aprobador de SIG Docs debe añadirlo al grupo adecuado de GitHub y al fichero OWNERS del contenido que está interesado en revisar.

SIG Docs approver, un aprobador del grupo de interés de documentación es un miembro de la organización de Kubernetes con buena reputación y que ha mostrado una compromiso continuado con el proyecto. Un aprobador se responsabiliza de mergear las pull requests y publicar contenido en nombre de la organización Kubernetes. Los aprobadores también pueden representar a SIG Docs en la comunidad de Kubernetes en general. Algunas de las responsabilidades de un aprobador de SIG Docs, como por ejemplo coordinar una release, requieren un compromiso de tiempo significativo.

Cómo contribuir

La siguiente lista está organizada por el nivel de implicación con la comunidad, desde las contribuciones que cualquiera puede hacer hasta las que requieren un compromiso con el equipo de documentación y estar familiarizado con los procesos de SIG Docs. Contribuir consistentemente a lo largo del tiempo puede ayudarte a comprender algunas de las herramientas y decisiones organizativas que se han ido tomando a lo largo del proyecto.

La lista no contiene todas las formas de contribución posibles, está pensada para proporcionar un punto de partida.

Todo el mundo

Abrir issues accionables para que el equipo pueda trabajar en ello

Miembro

Mejorar la documetanción existente
Proponer ideas de mejora en Slack o en SIG docs mailing list
Mejorar la accesibilidad de la documentación
Proporcionar comentarios no vinculantes sobre PRs
Escribir una entrada para el blog o un caso de estudio

Revisor

Documentar nuevas funcionalidades
Selección y clasificacion de nuevos Issues
Revisar PRs
Crear diagramas, material gráfico y screencasts / videos
Localización del contenido
Contribuye a otros repos como representante del equipo de documentación
Edit user-facing strings in code
Mejorar los comentarios de código, Godoc

Aprobador

Publicar el contenido de colaboradores aprobando y mergeando las PRs
Participar en el equipo de Release de Kubernetes como representeante del equipo de Docs
Proponer mejoras a la guía de estilo
Proponer mejoras a los tests de la documentación
Proponer mejoras al sitio web de Kubernetes y otras herramientas

Comentarios

¿Esta página le ha sido de ayuda?

Muchas gracias por el feedback. Si tienes alguna pregunta específica sobre como usar Kubernetes, puedes preguntar en Stack Overflow. Abre un issue en el repositorio de GitHub si quieres reportar un problema o sugerir alguna mejora.