Kubernetes accueille les améliorations de tous les contributeurs, nouveaux et expérimentés!
Pour en savoir plus sur comment contribuer à Kubernetes en général, consultez la documentation des contributeurs.
Vous pouvez également lire la page de CNCF sur la contribution à Kubernetes.
Ce site Web est maintenu par Kubernetes SIG Docs.
Contributeurs à la documentation Kubernetes:
- Améliorer le contenu existant
- Créer du nouveau contenu
- Traduire la documentation
- Gérer et publier la documentation faisant partie du cycle de mise à jour de Kubernetes
Démarrage
Tout le monde peut ouvrir un ticket concernant la documentation ou contribuer à une modification avec une pull request (PR) au
répertoire de GitHub kubernetes/website.
Vous devez être à l'aise avec git et GitHub pour travailler effectivement dans la communauté Kubernetes.
Pour participer à la documentation:
- Signez le Contributor License Agreement (CLA) du CNCF.
- Familiarisez-vous avec le répertoire de documentation et le générateur de site statique du site Web.
- Assurez-vous de comprendre les processus de base pour soumettre un pull request et examiner les modifications.
du cycle de mise à jour de K8s]
end
subgraph second[Révision]
direction TB
T[ ] -.-
D[Regarder
le site Web et
répertoire de K8s] --- E[Consulter le
générateur de
site statique Hugo]
E --- F[Comprendre les commandes
de base de GitHub]
F --- G[Réviser PR existantes
et changer les
procès de révision]
end
subgraph first[Inscription]
direction TB
S[ ] -.-
B[Signer le
Contributor License
Agreement de CNCF] ---
C[Joindre le canal Slack
appelé sig-docs] --- M[Participer aux
réunions vidéo hebdomadaires
ou réunion sur Slack]
end
A([fa:fa-user Nouveau
Contributeur]) --> first
A --> second
A --> third
A --> H[Posez des questions!!!]
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,C,D,E,F,G,H,M,Q,N,O,P grey
class S,T,U spacewhite
class first,second,third white
La figure 1 présente une feuille de route pour les nouveaux contributeurs. Vous pouvez suivre certaines ou toutes les étapes pour Inscription et Révision. Vous êtes maintenant prêt à soumettre des PRs qui atteignent vos objectifs de contribution, dont certains listés sous Soumettre PR. Encore une fois, les questions sont toujours les bienvenues !
Certaines tâches nécessitent plus de confiance et plus d'accès dans l'organisation Kubernetes. Visitez Participer à SIG Docs pour plus de détails sur les rôles et les autorisations.
Votre première contribution
Vous pouvez préparer votre première contribution en révisant à l'avance plusieurs étapes. La figure 2 décrit les étapes et les détails suivent.
autres membres de K8s] -->
A[Vérifiez la liste de problèmes
de K8s/website pour
des bon premiers PRs] --> B[Soumettez une PR!!]
end
subgraph first[Suggested Prep]
direction TB
T[ ] -.-
D[Lisez l'aperçu de contribution] -->E[Lisez le contenu de K8s
et guide de style]
E --> F[Étudiez sur les types de contenu
et shortcodes de Hugo]
end
first ----> second
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
class A,B,D,E,F,G grey
class S,T spacewhite
class first,second white
- Lisez l'aperçu de la contribution pour en savoir plus sur les différentes façons dont vous pouvez contribuer.
- Vérifiez la liste de problèmes
kubernetes/websitepour les problèmes qui constituent de bons points d'entrée. - Soumettez un pull request dans GitHub sur la documentation existante et apprenez-en plus sur comment créer des tickets dans GitHub.
- Révisez des pull requests d'autres membres de la communauté Kubernetes pour en vérifier l'exactitude et la langue.
- Lisez le contenu et les guides de stylede Kubernetes afin de pouvoir laisser des commentaires éclairés.
- Étudiez sur les types de contenu de page et shortcodesde Hugo.
Prochaines étapes
-
Apprenez à travailler à partir d'un clone local du répertoire.
-
Documentez les fonctionnalités d'une nouvelle version.
-
Participez à SIG Docs, et devenez un membre ou réviseur.
-
Demarrez ou aidez avec une localisation.
Engagez-vous dans SIG Docs
SIG Docs est le groupe de contributeurs qui publient et maintiennent la documentation Kubernetes et le site Web. S'impliquer dans SIG Docs est un excellent moyen pour les contributeurs Kubernetes (développement de fonctionnalités ou autre) d'avoir un impact important sur le projet Kubernetes.
SIG Docs communique avec différentes méthodes:
- Joignez
#sig-docsà l'instance Kubernetes sur Slack. Assurez-vous de vous présenter! - Joignez la liste de diffusion
kubernetes-sig-docs, où des discussions plus larges ont lieu et les décisions officielles sont enregistrées. - Joignez la réunion vidéo SIG Docs qui a lieu toutes les deux semaines. Les réunions sont toujours annoncées sur
#sig-docset ajoutées au calendrier des réunions de la communauté Kubernetes. Vous devrez télécharger Zoom ou vous connecter à l'aide d'un téléphone. - Joignez la réunion stand-up de SIG Docs sur Slack (async) les semaines où la réunion vidéo Zoom en personne n'a pas lieu. Les rendez-vous sont toujours annoncés sur
#sig-docs. Vous pouvez contribuer à l'un des fils de discussion jusqu'à 24 heures après l'annonce de la réunion.
Autres façons de contribuer
- Visitez le site de la communauté Kubernetes. Participez sur Twitter ou Stack Overflow, découvrez les meetups et événements Kubernetes locaux, et davantage encore.
- Lisez le cheatsheet de contributor pour vous impliquer dans le développement des fonctionnalités de Kubernetes.
- Visitez le site des contributeurs pour en savoir plus sur les contributeurs Kubernetes et des ressources supplémentaires pour les contributeurs.
- Soumettez un article de blog ou une étude de cas.