مشارکت در مستندات کوبرنتیز

این وبسایت توسط SIG Docs کوبرنتیز نگه‌داری می‌شود.
پروژه کوبرنتیز از کمک همه مشارکت‌کنندگان، چه تازه‌کار و چه باتجربه، استقبال می‌کند!

مشارکت‌کنندگان مستندات کوبرنتیز:

• بهبود محتوای موجود
• ایجاد محتوای جدید
• ترجمه مستندات
• مدیریت و انتشار بخش‌های مستندات در چرخه انتشار کوبرنتیز

تیم وب نوشت، که بخشی از SIG Docs است، به مدیریت وب نوشت‌های رسمی کمک می‌کند. برای کسب اطلاعات بیشتر،
مشارکت در وب نوشت‌های کوبرنتیز را بخوانید.

شروع کنید

هر کسی می‌تواند برای مستندات یک issue باز کند یا تغییری را با یک PR به مخزن GitHub kubernetes/website ارائه کند.
برای کار مؤثر در جامعه کوبرنتیز لازم است با git و GitHub آشنایی کافی داشته باشید.

برای مشارکت در مستندات:

1. توافق‌نامه مجوز مشارکت‌کنندگان (CLA) CNCF را امضا کنید:
   Contributor License Agreement.
2. با مخزن مستندات و مولد سایت ایستای این وبسایت آشنا شوید.
3. اطمینان حاصل کنید که فرایندهای پایه برای باز کردن یک PR و بازبینی تغییرات را می‌دانید.

flowchart TB
subgraph third[باز کردن PR]
direction TB
U[ ] -.-
Q[بهبود محتوا] --- N[ایجاد محتوا]
N --- O[ترجمه مستندات]
O --- P[مدیریت و انتشار بخش های مستندات
در چرخه انتشار کوبرنتیز]

end

subgraph second[بازبینی]
direction TB
   T[ ] -.-
   D[مرور مخزن
kubernetes/website] --- E[بررسی مولد سایت
ایستای Hugo]
   E --- F[درک دستورات پایه
GitHub]
   F --- G[بازبینی PRهای باز
و فرایندهای بازبینی تغییرات]
end

subgraph first[ثبت نام]
    direction TB
    S[ ] -.-
    B[توافق نامه مجوز مشارکت کنندگان CNCF را امضا کنید] --- C[به کانال Slack sig-docs بپیوندید]
    C --- V[به فهرست پستی kubernetes-sig-docs بپیوندید]
    V --- M[در تماس های هفتگی sig-docs یا جلسات Slack شرکت کنید]
end

A([fa:fa-user مشارکت کننده
جدید]) --> first
A --> second
A --> third
A --> H[سوال بپرسید!!!]


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,V grey
class S,T,U spacewhite
class first,second,third white

شکل ۱. شروع به کار برای یک مشارکت‌کننده جدید.

قدم ۱ یک نقشه راه برای مشارکت‌کنندگان تازه‌وارد ترسیم می‌کند. می‌توانید برخی یا همه مراحل «ثبت‌نام» (Sign up) و «بازبینی» (Review) را دنبال کنید. اکنون آماده‌اید تا PRهایی را باز کنید که اهداف مشارکت شما را برآورده سازند؛ برخی از این اهداف در بخش «ایجاد PR» (Open PR) فهرست شده‌اند. باز هم، سوالات همیشه مورد استقبال هستند!

برخی کارها به اعتماد و دسترسی بیشتری در سازمان کوبرنتیز نیاز دارند. برای جزئیات بیشتر درباره نقش‌ها و سطح دسترسی، مشارکت در SIG Docs را ببینید.

اولین مشارکت شما

شما می‌توانید با مرور چندین مرحله از قبل، برای اولین مشارکت خود آماده شوید.

شکل ۲ مراحل و جزئیات بعدی را شرح می‌دهد.

flowchart LR
    subgraph second[اولین مشارکت]
    direction TB
    S[ ] -.-
    G[بازبینی PRهای اعضای
دیگر K8s] -->
    A[بررسی فهرست Issues در
kubernetes/website برای PRهای
good first] --> B[باز کردن یک PR!!]
    end
    subgraph first[آماده سازی پیشنهادی]
    direction TB
       T[ ] -.-
       D[مرور نمای کلی مشارکت] -->E[خواندن راهنماهای
محتوا و سبک K8s]
       E --> F[یادگیری انواع محتوای صفحه در 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

گام ۲. آماده‌سازی برای نخستین مشارکت شما.

• برای آشنایی با روش‌های گوناگون مشارکت، نمای کلی مشارکت را بخوانید.
• فهرست issueها kubernetes/website را بررسی کنید تا سرنخ‌های مناسبی برای شروع بیابید.
• با باز کردن یک PR با استفاده از GitHub برای مستندات موجود، با نحوه ثبت Issue در GitHub بیشتر آشنا شوید.
• PR‌های سایر اعضای جامعه کوبرنتیز را از نظر درستی و نگارش بازبینی کنید.
• محتوا و راهنماهای سبک کوبرنتیز را مطالعه کنید تا بتوانید دیدگاه‌های آگاهانه ارائه دهید.
• درباره انواع محتوای صفحه و شورت‌کدهای Hugo بیشتر بیاموزید.

هنگام مشارکت کمک بگیرید

ارائه نخستین مشارکت می‌تواند دلهره‌آور باشد.
سفیران مشارکت‌کنندگان جدید
برای همراهی شما در انجام چند مشارکت اول حضور دارند. می‌توانید از طریق
Slack کوبرنتیز و ترجیحاً در کانال #sig-docs با آن‌ها ارتباط بگیرید.
همچنین تماس برای آشنایی و خوشامدگویی به مشارکت‌کنندگان جدید
در اولین سه‌شنبه هر ماه برگزار می‌شود. در آنجا می‌توانید با سفیران مشارکت‌کنندگان جدید تعامل کرده
و پرسش‌های خود را مطرح کنید.

گام‌های بعدی

• یاد بگیرید چگونه با یک clone محلی مخزن کار کنید.
• ویژگی‌های یک انتشار را مستند کنید.
• در SIG Docs مشارکت کنید و عضو یا بازبین شوید.
• یک بومی‌سازی را آغاز کنید یا در آن کمک کنید.

با SIG Docs همراه شوید

SIG Docs گروهی از مشارکت‌کنندگان است که مستندات کوبرنتیز و وبسایت آن را منتشر و نگه‌داری می‌کنند. مشارکت با SIG Docs راهی عالی برای مشارکت‌کنندگان کوبرنتیز (چه توسعه‌دهندگان قابلیت‌ها و چه سایر افراد) است تا تأثیر بزرگی بر پروژه کوبرنتیز بگذارند.

SIG Docs با روش‌های مختلفی ارتباط برقرار می‌کند:

• به کانال #sig-docs در Slack کوبرنتیز بپیوندید. حتماً خودتان را معرفی کنید!
• به لیست‌پستی kubernetes-sig-docs ملحق شوید؛ مباحث گسترده‌تر در اینجا انجام می‌شود و تصمیم‌های رسمی ثبت می‌شوند.
• در جلسه ویدئویی SIG Docs که هر دو هفته یک‌بار برگزار می‌شود شرکت کنید. این جلسات همیشه در #sig-docs اعلام شده و به تقویم جلسات جامعه کوبرنتیز افزوده می‌شوند. لازم است کلاینت Zoom را نصب کنید یا از طریق تلفن وارد شوید.
• در هفته‌هایی که جلسه حضوری Zoom برگزار نمی‌شود، در استندآپ غیرهمزمان (Async Stand-up) SIG Docs در Slack شرکت کنید. این جلسات نیز همیشه در #sig-docs اعلام می‌شوند. تا ۲۴ ساعت پس از اعلام جلسه می‌توانید در یکی از رشته‌ها مشارکت کنید.

راه‌های دیگر برای مشارکت کردن

• به وبسایت جامعه کوبرنتیز سر بزنید. در توییتر یا Stack Overflow مشارکت کنید، درباره گردهمایی‌ها و رویدادهای محلی کوبرنتیز و موارد دیگر مطلع شوید.
• cheatsheet مشارکت‌کنندگان را بخوانید تا در توسعه ویژگی‌های کوبرنتیز مشارکت کنید.
• از وبسایت مشارکت‌کنندگان دیدن کنید تا درباره مشارکت‌کنندگان کوبرنتیز و منابع تکمیلی مشارکت‌کنندگان بیشتر بدانید.
• بیاموزید چگونه در وب نوشت‌های رسمی مشارکت کنید
• یک مطالعه موردی ارسال کنید