پروژه بنیاد لینوکس

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه پروژه

سازمان منبع باز:
بنیاد لینوکس
نویسنده فنی:
بور
نام پروژه:
میزبانی و تولید اسناد را دوباره کار کنید و صفحات شروع و راهنماهای توسعه دهنده را بازسازی کنید.
طول پروژه:
طول استاندارد (3 ماه)

شرح پروژه

چکیده:

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

بدون یک مستندات خوب، کاربر ممکن است نداند که چگونه کارهای فوق را به طور موثر و کارآمد انجام دهد. اسناد و مدارک می توانند نقشی اساسی در تضمین موفقیت یک محصول داشته باشند زیرا ارتباطات عالی همیشه در قلب هر کسب و کار یا محصولی وجود دارد و خواهد بود و یک سند عالی فقط آن ارتباط را می گیرد و آن را در یک چارچوب قابل مدیریت قرار می دهد که همه می توانند برای موفقیت به آن دسترسی داشته باشند.

هر سایت مستندسازی نیاز به یک ساختمان خوب و یک خط لوله گردش کار میزبانی دارد، در سازمانی مانند AGL، با نسخه های متعدد و مستندات مفصل فراوان، فایل های اسناد (مارک داون ها) در چندین مخزن پخش شده اند و وظیفه نگهداری و به روز رسانی آنها را بسیار پیچیده می کند. و زمان فشرده

وضعیت فعلی:

  • وب‌سایت AGL doc بر اساس مجموعه‌ای از فایل‌های نشانه‌گذاری است که از مخازن مختلف واکشی شده‌اند.
  • صفحات سند در حال حاضر با استفاده از موتور پروژه کوردوا در منابع جداگانه به عنوان نشانه گذاری میزبانی می شوند.
  • این منجر به راه اندازی چهار مخزن برای ساخت اسناد و فرآیند میزبانی می شود:
  • Docs-webtemplate [https://github.com/automotive-grade-linux/docs-webtemplate] : حاوی الگوی وب سایت جکیل است.
  • Docs-tools [https://github.com/automotive-grade-linux/docs-tools] : شامل ابزارهایی برای تولید خودکار یک وب سایت فنی از فایل های Markdown است.
  • Docs-sources [https://github.com/automotive-grade-linux/docs-sources] : منبع (markdowns [https://github.com/automotive-grade-linux/docs-sources/tree/master/docs ]) برای اسناد عمومی، راهنماها.
  • Docs-gh-pages [https://github.com/automotive-grade-linux/docs-gh-pages] : مخزن صفحات GitHub مستقر برای سایت اسناد [https://gist.github.com/growupboron/docs. automotivelinux.org].
  • یک ابزار (اسکریپت) موجود در docs-tools [https://github.com/automotive-grade-linux/docs-tools] از جمع‌آوری و قالب‌بندی همه فایل‌های نشانه‌گذاری بر اساس fetched_files.yml واقع در docs-webtemplate [ https://github.com/automotive-grade-linux/docs-webtemplate].
  • جریان کار فعلی تولید وب سایت اسناد agl: current_workflow [https://drive.google.com/file/d/1OSwkVWFcsajgCOjbtdPf42EIfpidUJ0U/view?usp=sharing]
  • Section_version.yml حاوی پیوندهای تمام فایل‌های yaml کتاب است، و تمام فایل‌های yaml کتاب را از مخازن راه دور به docs-template [https://github.com/automotive-grade-linux/docs-webtemplate] واکشی می‌کند. فایل های کتاب yaml حاوی تمام آدرس های اینترنتی فایل های نشانه گذاری شما از مخزن راه دور است.
  • به محض اینکه همه فایل‌های علامت‌گذاری واکشی شدند، ابزارها برای تولید وب‌سایت سند AGL در صفحات docs-gh [https://github.com/automotive-grade-linux/docs-gh-pages] که به همین ترتیب است، پردازش می‌شود. مستقر شده است.
  • روند کنونی حفظ خط لوله برای کاربر و توسعه‌دهنده مناسب نیست، به‌ویژه برای مشارکت‌کنندگان جدید. این خط لوله گردش کار (ساختمان و میزبانی) را می توان برای توسعه دهندگان ساده تر و ساده تر کرد تا به جای حفظ جریان کار تولید و استقرار اسناد، روی بخش مستندات تمرکز کنند.