Kubernetes accueille les améliorations de tous les contributeurs, nouveaux et expérimentés!


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:

  1. Signez le Contributor License Agreement (CLA) du CNCF.
  2. Familiarisez-vous avec le répertoire de documentation et le générateur de site statique du site Web.
  3. Assurez-vous de comprendre les processus de base pour soumettre un pull request et examiner les modifications.

flowchart TB subgraph third[Soumettre PR] direction TB U[ ] -.- Q[Améliorer contenu] --- N[Créer contenu] N --- O[Traduire docs] O --- P[Gérer/publier docs faisant partie
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
Figure 1. Premiers pas pour un nouveau contributeur.

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.

flowchart LR subgraph second[Première Contribution] direction TB S[ ] -.- G[Révisez les PRs des
autres membres de K8s] --> A[Vérifiez la liste de problèmes
de kubernetes/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
Figure 2. Préparation pour votre première contribution.

Prochaines étapes

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:

Autres façons de contribuer

Dernière modification June 20, 2024 at 12:44 PM PST: Sync changest from andygol/k8s-website (36d05bc8a1)