Edit This Page

Contribuer à la documentation Kubernetes

Contribution documentation Kubernetes

Si vous souhaitez contribuer à la documentation ou au site Web de Kubernetes, nous serons ravis de vous aider! Tout le monde peut contribuer, que vous soyez nouveau dans le projet ou que vous y travailliez depuis longtemps, et que vous vous identifiez vous-même en tant que développeur, utilisateur final ou quelqu'un qui ne supporte tout simplement pas les fautes de frappe.

Pour vous impliquer de plusieurs façons dans la communauté Kubernetes ou d’en savoir plus sur nous, visitez le Site de la communauté Kubernetes. Pour plus d'informations sur le guide de style de la documentation Kubernetes, reportez-vous à la section style guide.

Types de contributeurs

  • Un membre de l'organisation Kubernetes qui a signé le CLA et contribué un peu de temps et d'efforts au projet. Voir Adhésion à la communauté pour des critères spécifiques d'adhésion.
  • Un SIG Docs relecteur est un membre de l'organisation Kubernetes qui   a exprimé son intérêt pour l'examen des Pull Requests de la documentation et qui a été ajouté au groupe GitHub approprié et aux fichiers OWNERS dans le dépôt GitHub, par un approbateur SIG Docs.
  • Un SIG Docs approbateur est un membre en règle qui a démontré un engagement continu envers le projet. Un approbateur peut fusionner des Pull Requests et publier du contenu au nom de l'organisation Kubernetes. Les approbateurs peuvent également représenter les documents SIG dans la communauté plus large de Kubernetes. Certaines des tâches d’un approbateur SIG Docs, telles que la coordination d’une publication, nécessitent un temps considérable.

Façons de contribuer

Cette liste est divisée en tâches accessibles à tous, ou juste aux membres de l'organisation Kubernetes, ou encore en tâches requérant un haut niveau d'autorisation et de familiarité avec les processus SIG Docs. Contribuer de manière constante au fil du temps peut vous aider à comprendre certaines des décisions relatives à l’outillage et à l’organisation qui ont déjà été prises.

Il ne s'agit pas d'une liste exhaustive des manières dont vous pouvez contribuer à la documentation de Kubernetes, mais cela devrait vous aider à démarrer.

  • N'importe qui
    • Remplir des rapports d'anomalie reproductibles
  • Membre
    • Améliorer la documentation existante
    • Proposer des idées d'améliorations sur Slack ou sur la liste de diffusion SIG docs
    • Améliorer l'accessibilité de la documentation
    • Fournir des commentaires non contraignants sur les PRs
    • Écrire un article de blog ou une étude de cas
  • Relecteur
    • Documenter les nouvelles fonctionnalités
    • Trier et classer les problèmes
    • Relire des PRs
    • Créez des diagrammes, des ressources graphiques et des vidéos / capture vidéo d'écran incorporables
    • Localisation
    • Contribuer à d'autres dépôts en tant que représentant de la documentation
    • Éditer des chaînes pour l'utilisateur dans le code
    • Améliorer les commentaires dans le code, Godoc
  • Approbateur
    • Publier le contenu des contributeurs en approuvant et en fusionnant les PRs
    • Participer à une équipe de publication de Kubernetes en tant que représentant de la documentation
    • Proposer des améliorations au guide de style
    • Proposer des améliorations aux tests de documentation
    • Proposer des améliorations au site Web de Kubernetes ou à d'autres outils