Co-authored-by: Tim Bannister <tim@scalefactory.com>
6.6 KiB
مستندات کوبرنتیز
این مخزن شامل مواردی است که برای ساخت مستندات و وب سایت کوبرنتیز به آنها نیاز است. ما از این که شما قصد مشارکت دارید خوشحال هستیم.
اجرای وب سایت در سیستم خود با استفاده از هوگو
برای دریافت مستندات نصب هوگو لطفاً به سایت مستندات رسمی هوگو وارد شوید. قبل از هر چیز مطمئن شوید که نسخه توسعه یافته هوگو را
دریافت نمودهاید. برای این کار باید متغییر محیطی HUGO_VERSION را در فایل netlify.toml بررسی نمایید.
قبل از ساختن سایت، مخزن وب سایت کوبرنتیز را کلون نمایید:
git clone https://github.com/kubernetes/website.git
cd website
git submodule update --init --recursive --depth 1
توجه: وب سایت کوبرنتیز تم هوگو داکی را برای استقرار استفاده میکند.
اگر مخزن وب سایت خود را بروزرسانی نکردهاید، مسیر website/themes/docsy خالی خواهد بود و وب سایت بدون یک کپی از آن تم ساخته نخواهد شد.
برای بروزرسانی تم وب سایت از دستور زیر استفاده شود:
git submodule update --init --recursive --depth 1
برای ساخت و تست سایت در داخل سیستم خود میتوانید از دستور زیر استفاده کنید:
hugo server --buildFuture
مشارکت در SIG مستندسازی
شما میتوانید با استفاده از لینک روبرو در مورد SIG مستندسازی کوبرنتیز و جلسات آنها اطلاعات بیشتری را بدست آورید. صفحه جامعه کوبرنتیز
همچنین شما میتوانید با نگهدارنگان پروژه کوبرنتیز با استفاده از لینکهای زیر در تماس باشید:
کمک به مستند سازی این پروژه
با استفاده از دکمه Fork که در ناحیه بالا سمت راست قرار گرفته است میتوانید یک کپی از این مخزن را در حساب Github خود کپی کنید. به این کپی اصطلاحاً fork گفته می شود. تغییراتی را که مد نظر دارید را در نسخه fork شده اعمال کنید و هنگامی که آماده بودید این تغییرات را برای ما ارسال کنید که این کار از طریق درخواست pull انجام میشود.
زمانی که درخواست pull شما برای یکی از بازبینان کوبرنتیز ارسال شد، وی موظف به ایجاد یک بازخورد واضح و قابل اعمال است. به عنوان مالک درخواست کننده pull وظیفه شماست که به اصلاح مواردی بپردازید که بازبین برای شما به عنوان بازخورد مشخص کرده است.
همچنین باید این نکته را توجه داشته باشید که ممکن است بیشتر از یک بازبین کوبرنتیز برای کار شما بازخورد ایجاد کند و یا اینکه حتی بازخوردی را دریافت کنید که با بازخورد ابتدایی متفاوت باشد.
علاوه بر این، در برخی موارد ممکن است یکی از بازبینان در صورت لزوم از یک بازبین فنی بخواهد تا بازخوردی را برای شما انجام دهد. بازبینان تمام تلاش خود را میکند که بازخوردهای خود را در سریعترین زمان به شما پاسخ بدهند ولی زمانبندی این موضوع میتواند بنا به شرایط متفاوت باشد.
برای اطلاعات بیشتر در خصوص مشارکت در مستندسازی کوبرنتیز به لینکهای زیر مراجعه کنید:
بومیسازی README.md's
| زبان | زبان |
|---|---|
| چینی | کرهای |
| فرانسوی | لهستانی |
| آلمانی | پرتغالی |
| هندی | روسی |
| اندونزیایی | اسپانیایی |
| ایتالیایی | اوکراینی |
| ژاپنی | ویتنامی |
| فارسی |
مرام نامه
مشارکت در جامعه کوبرنتیز توسط CNCF مرام نامه انجام می شود.
سپاس
کوبرنتیز با مشارکت جامعه شکوفا می شود و ما از کمک شما برای ارائه کمکهایتان به وب سایت و مستندسازی مستنداتمان سپاسگزار هستیم.