Bienvenue ! Ce référentiel contient toutes les informations nécessaires à la construction du site web et de la documentation de Kubernetes. Nous sommes très heureux que vous vouliez contribuer !
Vous pouvez cliquer sur le bouton Fork en haut à droite de l'écran pour créer une copie de ce dépôt dans votre compte GitHub. Cette copie s'appelle un fork. Faites tous les changements que vous voulez dans votre fork, et quand vous êtes prêt à nous envoyer ces changements, allez dans votre fork et créez une nouvelle pull request pour nous le faire savoir.
Une fois votre pull request créée, un examinateur de Kubernetes se chargera de vous fournir une revue claire et exploitable. En tant que propriétaire de la pull request, il est de votre responsabilité de modifier votre pull request pour tenir compte des commentaires qui vous ont été fournis par l'examinateur de Kubernetes. Notez également que vous pourriez vous retrouver avec plus d'un examinateur de Kubernetes pour vous fournir des commentaires ou vous pourriez finir par recevoir des commentaires d'un autre examinateur que celui qui vous a été initialement affecté pour vous fournir ces commentaires. De plus, dans certains cas, l'un de vos examinateur peut demander un examen technique à un examinateur technique de Kubernetes au besoin. Les examinateurs feront de leur mieux pour fournir une revue rapidement, mais le temps de réponse peut varier selon les circonstances.
Pour plus d'informations sur la contribution à la documentation Kubernetes, voir :
- Commencez à contribuer
- Apperçu des modifications apportées à votre documentation
- Utilisation des modèles de page
- Documentation Style Guide
- Traduction de la documentation Kubernetes
La façon recommandée d'exécuter le site web Kubernetes localement est d'utiliser une image spécialisée Docker qui inclut le générateur de site statique Hugo.
Si vous êtes sous Windows, vous aurez besoin de quelques outils supplémentaires que vous pouvez installer avec Chocolatey.
choco install install make
Si vous préférez exécuter le site Web localement sans Docker, voir Exécuter le site localement avec Hugo ci-dessous.
Si vous avez Docker up and running, construisez l'image Docker `kubernetes-hugo' localement:
make docker-imageUne fois l'image construite, vous pouvez exécuter le site localement :
make docker-serveOuvrez votre navigateur à l'adresse: http://localhost:1313 pour voir le site. Lorsque vous apportez des modifications aux fichiers sources, Hugo met à jour le site et force le navigateur à rafraîchir la page.
Voir la documentation officielle Hugo pour les instructions d'installation Hugo.
Assurez-vous d'installer la version Hugo spécifiée par la variable d'environnement HUGO_VERSION dans le fichier netlify.toml.
Pour exécuter le site localement lorsque vous avez Hugo installé :
make serveLe serveur Hugo local démarrera sur le port 1313. Ouvrez votre navigateur à l'adresse: http://localhost:1313 pour voir le site. Lorsque vous apportez des modifications aux fichiers sources, Hugo met à jour le site et force le navigateur à rafraîchir la page.
Apprenez comment vous engager avec la communauté Kubernetes sur la page communauté.
Vous pouvez joindre les responsables de ce projet à l'adresse :
La participation à la communauté Kubernetes est régie par le Code de conduite de Kubernetes.
Kubernetes prospère grâce à la participation de la communauté, et nous apprécions vraiment vos contributions à notre site et à notre documentation !