SIG Docs es uno de los grupos de interés especial dentro del proyecto Kubernetes, centrado en escribir, actualizar y mantener la documentación de Kubernetes en su conjunto. Consulta SIG Docs en el repositorio de GitHub de la comunidad para obtener más información sobre el SIG.
SIG Docs recibe con agrado contenido y revisiones de todas las personas colaboradoras. Cualquiera puede abrir una solicitud de cambios (PR), y cualquiera puede informar de problemas relacionados con el contenido o comentar en las solicitudes de cambios en curso.
También puedes convertirte en un miembro, revisor o aprobador. Estos roles requieren un mayor nivel de acceso y conllevan ciertas responsabilidades para aprobar y hacer commit de cambios. Consulta la membresía de la comunidad para obtener más información sobre cómo funciona la membresía dentro de la comunidad de Kubernetes.
El resto de este documento describe algunas formas particulares en las que funcionan estos roles dentro de SIG Docs, que se encarga de mantener uno de los aspectos más visibles para el público de Kubernetes: el sitio web y la documentación de Kubernetes.
Cada SIG, incluido SIG Docs, elige a uno o más miembros del SIG para ejercer la presidencia. Estas personas son puntos de contacto entre SIG Docs y otras partes de la organización de Kubernetes. Requieren un conocimiento amplio de la estructura del proyecto Kubernetes en su conjunto y del funcionamiento de SIG Docs. Consulta Liderazgo para ver la lista actual de presidentes.
La automatización de SIG Docs depende de dos mecanismos diferentes: los equipos de GitHub y los archivos OWNERS.
En GitHub hay dos categorías de equipos de SIG Docs:
@sig-docs-{language}-owners son aprobadores y responsables@sig-docs-{language}-reviews son revisoresPuedes mencionar a cada equipo con su @name en los comentarios de GitHub para
comunicarte con todas las personas que forman parte de ese grupo.
A veces Prow y los equipos de GitHub se solapan sin coincidir exactamente. Para asignar problemas y solicitudes de cambios, y para respaldar la aprobación de solicitudes de cambios, la automatización utiliza la información de los archivos OWNERS.
El proyecto Kubernetes utiliza una herramienta de automatización llamada Prow para automatizar las incidencias y las solicitudes de cambios de GitHub. El repositorio del sitio web de Kubernetes utiliza dos plugins de Prow:
Estos dos plugins utilizan los archivos
OWNERS y
OWNERS_ALIASES
del nivel superior del repositorio de GitHub kubernetes/website para
controlar el funcionamiento de Prow dentro del repositorio.
Un archivo OWNERS contiene una lista de revisores y aprobadores de SIG Docs. Los archivos OWNERS también pueden existir en subdirectorios y pueden sustituir a las personas que pueden actuar como revisores o aprobadores de los archivos de ese subdirectorio y sus descendientes. Para obtener más información sobre los archivos OWNERS en general, consulta OWNERS.
Además, un archivo Markdown individual puede incluir revisores y aprobadores en su front matter, ya sea mediante nombres de usuario individuales de GitHub o grupos de GitHub.
La combinación de los archivos OWNERS y el front matter de los archivos Markdown determina los consejos que los propietarios de las solicitudes de cambios reciben de los sistemas automatizados sobre a quién solicitar una revisión técnica y editorial.
Cuando una solicitud de cambios se fusiona en la rama utilizada para publicar contenido, ese contenido se publica en https://kubernetes.io. Para garantizar la alta calidad del contenido publicado, limitamos la fusión de solicitudes de cambios a los aprobadores de SIG Docs. Así es como funciona.
lgtm y approve, no tiene
etiquetas hold y todas las pruebas pasan, la solicitud de cambios se fusiona
automáticamente./hold o no añadiendo un comentario
/lgtm).lgtm escribiendo un
comentario /lgtm./approve. Algunos aprobadores también desempeñan
funciones específicas adicionales, como coordinador de PR
o presidente de SIG Docs.Para obtener más información sobre cómo participar en SIG Docs, consulta:
Para obtener más información sobre cómo contribuir a la documentación de Kubernetes, consulta: