La documentación de Kubernetes

Bienvenido! Este repositorio contiene todos los recursos necesarios para construir el sitio web de Kubernetes y su documentación. ¡Estamos encantados de que quiera contribuir!

Contribuyendo con la documentación

Puede hacer clic en el botón Fork situado en la esquina superior derecha de la pantalla para crear una copia de este repositorio en su cuenta de GitHub. A ese tipo de copia se le llama Fork (bifurcación) y le permite editar el contenido del repositorio en su copia personal. Realice los cambios que quiera en su fork y, cuando esté listo para enviarnos esos cambios, vaya a fork en repositorio en su GitHub y cree una nueva pull request para que tengamos constancia de la propuesta de cambios.

Una vez la pull request ha sido creada, un revisor de Kubernetes asumirá la responsabilidad de proporcionar comentarios claros y prácticos sobre como continuar. Como propietario de la PR, es su responsabilidad modificar la pull request para abordar los comentarios proporcionados por el revisor de Kubernetes. Tenga en cuenta que algunas veces puede terminar teniendo más de un revisor de Kubernetes participando en la revisión, por lo que es posible que reciba comentarios de más revisores a parte del asignado originalmente en la creación de la pull request. Además, en algunas ocasiones, es posible que uno de sus revisores solicite una revisión técnica por parte de un revisor técnico de Kubernetes si lo considera necesario.

Los revisores harán todo lo posible para proporcionar toda la información necesaria para que la pull request siga adelante en un tiempo razonable, pero este tiempo de respuesta puede variar según las circunstancias.

Para obtener más información sobre cómo contribuir a la documentación de Kubernetes, puede consultar:

Levantando el sitio web kubernetes.io en su entorno local con Docker

El método recomendado para levantar una copia local del sitio web kubernetes.io es utilizando la imagen de Docker que incluye el generador de sitios estáticos Hugo.

Para Windows, algunas otras herramientas como Make son necesarias. Puede instalarlas utilizando el gestor Chocolatey. choco install make o siguiendo las instrucciones de Make for Windows.

Si prefiere levantar el sitio web sin utilizar Docker, puede seguir las instrucciones disponibles en la sección Levantando kubernetes.io en local con Hugo.

Nota: Para el procedimiento de construir una imagen de Docker e iniciar el servidor. El sitio web de Kubernetes utiliza Docsy Hugo theme. Se sugiere que se instale si aún no se ha hecho, los submódulos y otras dependencias de herramientas de desarrollo ejecutando el siguiente comando de git:

# pull de los submódulos del repositorio
git submodule update --init --recursive --depth 1

Si identifica que git reconoce una cantidad innumerable de cambios nuevos en el proyecto, la forma más simple de solucionarlo es cerrando y volviendo a abrir el proyecto en el editor. Los submódulos son automáticamente detectados por git, pero los plugins usados por los editores pueden tener dificultades para ser cargados.

Una vez tenga Docker configurado en su máquina, puede construir la imagen de Docker kubernetes-hugo localmente ejecutando el siguiente comando en la raíz del repositorio:

make container-image

Una vez tenga la imagen construida, puede levantar el sitio web ejecutando:

make container-serve

Abra su navegador y visite http://localhost:1313 para acceder a su copia local del sitio. A medida que vaya haciendo cambios en el código fuente, Hugo irá actualizando la página y forzará la actualización en el navegador.

Levantando kubernetes.io en local con Hugo

Revise la documentación oficial de Hugo para obtener las instrucciones de instalación en su sistema operativo. Asegúrese de instalar la versión de Hugo especificada en la variable de entorno HUGO_VERSION del fichero netlify.toml.

Para levantar el sitio localmente una vez Hugo está instalado en su sistema, puede ejecutar el siguiente comando:

make serve

Este comando levantará un servidor de Hugo en el puerto 1313 al que podrá acceder visitando http://localhost:1313 y dónde podrá visualizar su copia local del sitio web. A medida que vaya haciendo cambios en el código fuente, Hugo irá actualizando la página y forzará la actualización en el navegador.

Comunidad, discusión, contribuir y soporte

Aprenda como participar en la comunidad de Kubernetes visitando la página de comunidad.

Puede ponerse en contacto con los mantenedores de este proyecto en:

Código de conducta

La participación en la comunidad de Kubernetes está regulada por el Código de Conducta de Kubernetes.

¡Muchas gracias!

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

Agradecemos muchísimo sus contribuciones a nuestro sitio web y nuestra documentación.