DjangoPersianDocumentation

DjangoPersianDocumentation copied to clipboard

توضیحات پروژه:

• مستندات مربوط به کدام نسخه جنگو میباشند؟
  • درحال حاضر نسخه ۳.۲
• آیا مشارکت در پروژه نیازی به دانستن sphinx دارد؟
  • برای ترجمه شما تنها باید متن انگلیسی را به فارسی تغییر دهید و این موضوع در کل هیچ ارتباطی با درک و فهم sphinx ندارد، اما دانستن آن خالی از لطف نیست.
• آیا این پروژه به صورت انلاین در دسترس است؟
  • پروژه فعلا درحال توسعه میباشد و پس از تکمیل بخش های کلی آن به صورت آنلاین در دسترس قرار میگیرد.

شروع کار با پروژه:

• مستندات درحال حاضر برمبنای آخرین ورژن LTS جنگو یعنی نسخه ۳.۲ میباشند و این پروژه ترجمه مستنداتی است که در اینجا قابل مشاهده میباشد.

مراحل ایجاد پروژه:

• این مخزن را از طریق گیت یا از این لینک دانلود کنید.
• جنگو ۳.۲ را از این لینک دانلود کنید (تقریبا ۱۴مگ).
• بعد از دانلود پوشه جنگو ۳.۲ را باز کنید و نام پوشه ‍‍‍‍‍‍‍docs را به django-docs تغییر دهید
• پوشه django-docs را در پوشه این پروژه که نام ان ‍‍‍‍DjangoPersianDocumentation میباشد کپی کنید (اگر این پروژه را از طریق لینک دانلود کرده باشید احتمالا نام برنچ به پایان آن اضافه شده است که میتوانید در صورت لزوم نام آن را به ‍‍DjangoPersianDocumentation تغییر دهید یا به همین شکل ادامه دهید).
• به صورت کلی ما در پروژه ۲ پوشه جدید به نام های django-docs و local-docs داریم که اولین مورد، پوشه مستندات رسمی خود جنگو و دومین مورد، پوشه ای شامل آخرین تغییرات پروژه(‍‍docs) به روی مستندات خود جنگو(‍django-docs) میباشد. به صورت پیشفرض این اسامی در فایل های local-project-creator.py و .gitignore قرار داده شده اند و در صورت تغییر نام ها باید این مقادیر در دو فایل دوباره ست شوند.
• پوشه local-docs، هنوز ایجاد نشده است و باید آخرین تغییرات پروژه را به روی مستندات جنگو اعمال کنیم. برای اینکار ماژول local-project-creator.py را ران کنید تا این فایل ایجاد شود.
• بعد از انجام مراحل، ساختار پروژه باید چیزی شبیه زیر باشد:

* DjangoPersianDocumentation
  | django-docs/ (ignored by .gitignore)
  | docs/
  | local-docs/ (ignored by .gitignore)
  | .gitignore
  | local-project-creator.py
  | README.md
  | requirements.txt
  | translations-status.md
  | ...

نصب پیش نیازها:

• برای کار با پروژه ابتدا باید پیش نیازهای پروژه را نصب کنید. برای اینکار ابتدا محیط مجازی خود را ایجاد کنید (آموزش نحوه ایجاد محیط مجازی). پس از فعالسازی محیط مجازی با دستور pip install -r requirements.txt پیش نیازهای پروژه را نصب کنید.

کار با پروژه:

• بعد از انجام مراحل بالا تنها کافیست وارد پوشه local-docs شوید و دستور make.bat html (یا make html) را برای ایجاد فایل های html از فایل های خام اجرا کنید. پس از مدتی پوشه ای به نام _build ایجاد خواهد شد که درون آن پوشه ای به نام html قرار دارد که شامل تمام فایل های html پروژه میباشد.
• برای دیدن مستندات کافیست فایل index.html را باز کنید و نتیجه را مشاهده کنید.

نحوه مشارکت در پروژه:

• پس از بررسی این فایل ، بخش مورد نظر خود را در گروه اعلام کنید تا از ترجمه همزمان یک صفحه توسط چندنفر جلوگیری شود. پس از آن کافیست تغییرات را در فایل های تکست ایجاد کنید و هربار برای دیدن نتایج از دستور make.bat html (یا make html) استفاده کنید.
• در آخر پس از ایجاد تغییرات لازم، فایل ادیت شده را با همان آدرس نسبت به پوشه local-docs در پوژه docs قرار دهید و تغییرات را ارسال کنید.
• بهتر است قبل از شروع ترجمه، بعد از ایجاد فایل های html مستندات، به فایل about در مستندات نگاهی بیندازید.
  

گروه تلگرام : https://t.me/DjangoPersianDocumentation

روز خوبی داشته باشید♥️