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

Netlify Status GitHub release

‫ خوش آمدید! این مخزن شامل محتویات لازم برای ساخت تارنما کوبرنتیز فارسی و مستندات آن است. خوشحال می‌شویم که در این مسیر با مشارکت کردن ما را همراهی کنید.

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

‫ شما می‌توانید روی دکمه‌ی Fork در گوشه‌ی سمت راست بالای صفحه کلیک کنید تا یک رونوشت از این مخزن در حساب گیت‌هاب خود ایجاد کنید. این رونوشت fork نامیده می‌شود. تغییرات دلخواه را در fork خود اعمال کنید. وقتی آماده‌ی ارسال آن تغییرات به ما شدید، به fork خود بروید و یک درخواست ادغام جدید(PR) ایجاد کنید و به ما اطلاع دهید.

‫ پس از ایجاد درخواست ادغام از سمت شما، فرد بررسی‌کننده تیم مستندات فارسی کوبرنتیز مسئولیت ارائه بازخورد و بررسی درخواست شما را بر عهده می‌گیرد. به عنوان صاحب درخواست ادغام، مسئولیت اصلاح درخواست ادغام بر اساس بازخوردی که از بررسی‌کننده تیم مستندات فارسی کوبرنتیز دریافت می‌کنید، بر عهده شماست. همچنین، توجه داشته باشید که ممکن است در نهایت بیش از یک بررسی‌کننده بازخورد ارائه دهند، یا ممکن است از فرد بررسی‌کننده جدید و متفاوت از کسی که در ابتدا برای ارائه بازخورد تعیین شده بود، بازخورد دریافت کنید. در برخی موارد، در صورت نیاز، یکی از بررسی‌کنندگان شما ممکن است از یک بررسی‌کننده فنی کوبرنتیز درخواست بررسی فنی کند. بررسی‌کنندگان تمام تلاش خود را می‌کنند تا بازخوردها را به موقع ارائه دهند، اما زمان پاسخگویی بسته به شرایط ممکن است متفاوت باشد.

‫ برای اطلاعات بیشتر در مورد مشارکت در مستندسازی کوبرنتیز به فارسی به پیوندهای زیر مراجعه کنید:

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

فارسی

‫ با تیم بومی سازی فارسی می‌توانید از طریق نشانی های زیر در ارتباط باشید: ‫

اجرای تارنما با Docker

‫ برای اجرای تارنما کوبرنتیز، توصیه می‌شود آن را با Docker اجرا کنید که شامل مولد تارنما استاتیک Hugo باشد.

در ویندوز، به ابزارهای اضافی نیاز دارید که می‌توانید با Chocolatey نصب کنید. choco install make

اگر ترجیح می‌دهید تارنما را بدون Docker اجرا کنید، به اجرای تارنما با Hugo مراجعه کنید.

‫ قالب مورد نیاز Docsy Hugo theme باید به عنوان یک زیرماژول git نصب شود:

git submodule update --init --recursive --depth 1

‫ اگر Docker را نصب کرده‌اید، image Docker hugo را ایجاد کنید:

make container-image

‫ پس از ایجاد image، می‌توانید تارنما را راه اندازی کنید:

make container-serve

‫ برای مشاهده تارنما، مرورگر خود را با نشانی http://localhost:1313 باز کنید. وقتی تغییراتی در پرونده‌های منبع ایجاد می‌کنید، Hugo تارنما را به‌روزرسانی کرده و مرورگر را مجبور به فراخوانی مجدد می‌کند.

اجرای تارنما با Hugo

‫ دستورالعمل‌های نصب Hugo را می‌توانید در مستندات رسمی بیابید. مطمئن شوید که نسخه Hugo مشخص شده در متغیر محیطی HUGO_VERSION در فایل netlify.toml را نصب می‌کنید.

‫ قالب مورد نیاز Docsy Hugo theme باید به عنوان یک زیرماژول git نصب شود:

git submodule update --init --recursive --depth 1

‫ برای اجرای تارنما در صورتی که Hugo را نصب کرده‌اید:

npm ci
make serve

‫ برای مشاهده تارنما، مرورگر خود را با نشانی http://localhost:1313 باز کنید. وقتی تغییراتی در پرونده‌های منبع ایجاد می‌کنید، Hugo تارنما را به‌روزرسانی کرده و مرورگر را مجبور به فراخوانی مجدد می‌کند.

جامعه، بحث، مشارکت و حمایت

‫ برای آشنایی با نحوه تعامل با انجمن کوبرنتیز به صفحه انجمن مراجعه کنید.

‫ برای ارتباط با سرپرستان این پروژه می‌توانید از طریق نشانی زیر اقدام کنید:

قوانین رفتاری

‫ مشارکت در جامعه کوبرنتیز تابع آیین‌نامه رفتاری کوبرنتیز است.

سپاس گزاریم

‫ کوبرنتیز با مشارکت جامعه رونق می‌گیرد و ما از مشارکت‌های شما در تارنما و مستندات کوبرنتیز فارسی استقبال می‌کنیم. دمتون گرم!