این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- پروژه FreeBSD
- نویسنده فنی:
- لری
- نام پروژه:
- به روز رسانی کتاب های راهنمای FreeBSD
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
این پروژه GSoD2020 شامل دو فصل در کتابچه راهنمای FreeBSD خواهد بود:
- تست: فصل جدید در کتابچه راهنمای توسعه دهندگان FreeBSD
- LDAP: مقاله به روز شده در کتاب راهنمای FreeBSD در یک فصل ادغام شد
تست: فصل جدید در کتابچه راهنمای توسعه دهندگان FreeBSD:
توجه: این پروژه در ابتدا بیشتر اکتشافی است. الزامات ممکن است در مرحله نوشتن تغییر کند.
وظایف آماده سازی عبارتند از: * بررسی اسناد و یادداشت های فعلی در مورد چارچوب های آزمایش توسعه دهندگان، شیوه ها، و غیره برای FreeBSD و سایر BSD (ها). * اسناد و یادداشت های FreeBSD فعلی یا قدیمی تر. به عنوان مثال: * TestSuite: https://wiki.freebsd.org/TestSuite * صفحه قدیمی ""TestingFreeBSD": https://wiki.freebsd.org/TestingFreeBSD * اسناد و یادداشت های فعلی از پروژه های مرتبط. به عنوان مثال: * http://wiki.netbsd.org/tutorials/atf/ * مستندات اولیه ابزارهای درگیر. به عنوان مثال: * چارچوب تست Kyua: https://github.com/jmmv/kyua/ * چارچوب تست خودکار (ATF): https://github.com/jmmv/atf/ * نصب و پیکربندی چارچوب های مربوطه برای کسب آشنایی . * استفاده از چارچوب های تست برای اجرای تست های فعلی. * نوشتن تعداد کمی تست جدید. * (بسیار مهم) مشاوره با خوانندگان (توسعه دهندگان نرم افزار و آزمایش کنندگان) در مورد آنچه که می خواهند در این فصل ببینند.
قرار است سازماندهی دقیق اسناد مشخص شود. با این حال، پس از خواندن فصل، خواننده باید حداقل بتواند کارهای زیر را انجام دهد:
- چارچوب های آزمایشی را برای اهداف آزمایش FreeBSD نصب و پیکربندی کنید.
- یک تست برای چارچوب تست بنویسید.
- تستی را در چارچوب تست اجرا کنید.
موارد زیر در صورت امکان تاکید خواهد شد: * به حداکثر رساندن اتوماسیون برای کاهش کار در راهاندازی زیرساخت تست، نوشتن تستها و اجرای تستها. * افزودن موارد آزمایشی هر زمان که یک باگ جدید برطرف شد. * تست رگرسیون خودکار جامع. * (در صورت لزوم) شامل نمونه هایی از سناریوهای تست استاندارد، مانند تست واحد، تست عملکرد، تست بار و غیره.
در صورت امکان، هدف نه تنها توضیح و راهنمایی توسعهدهنده از طریق چارچوب آزمایشی است، بلکه امیدواریم این فرآیند تا حد امکان ساده باشد تا توسعهدهندگان تشویق شوند تا آزمایشهای بیشتری را انجام دهند و توسعهدهندگان جدید از مشارکت منصرف نشوند.
LDAP: مقاله به روز شده در کتاب راهنمای FreeBSD در یک فصل ادغام شده است:
برخلاف فصل تست، دامنه مقاله یا فصل به روز شده در مورد LDAP به خوبی درک شده است.
فصل جاری در هندبوک FreeBSD و مقاله فعلی هر دو حاوی اطلاعات مفید زیادی هستند. با این حال، آنها باید به روز شوند. ویرایش جدیدی از مقاله که برای تبدیل شدن به فصل جدید آغاز شده است، آغاز شده است، اما باید تکمیل شود.
وظایف عبارتند از: * تصحیح فصل کتاب راهنمای فعلی و مقاله فعلی. * در آماده سازی برای GSoD2020، یک پاس اولیه انجام شده است. * تست هر بخش در کتابچه راهنما برای تأیید اینکه چه چیزی کار می کند و چه چیزی باید اصلاح شود. * در آماده سازی برای GSoD2020، پیکربندی سرور با بهبودهای شناسایی شده آزمایش شده است. * بخش های دیگر باقی مانده است. * نوشتن مطالب جدید و تجدید نظر در محتوای فعلی. * محتوای به روز شده برای بخش سرور شروع شده است. باید تکمیل شود. * بخش های دیگر باقی مانده است. * تست تمام محتوا در سیستم های FreeBSD تمیز پس از تکمیل پیش نویس نهایی. * این کار بسیار مهم است زیرا هر شکافی را شناسایی می کند.
انتظار می رود فصل پایانی مقاله یا کتاب راهنما شامل بخش های زیر باشد:
(1) مقدمه ای بر LDAP (2) پیکربندی سرور: (الف) توضیحی توضیحی از یک پیکربندی سرور OpenLDAP اولیه اما کاربردی در FreeBSD. (ب) یک مثال کامل از پیکربندی سرور OpenLDAP اولیه اما کاربردی، به عنوان مثال نتیجه (2a)، در FreeBSD.
""اصلی اما کاربردی"" شامل پیکربندی سرور با گذرواژه های هش شده، اتصالات ایمن از طریق شبکه و داده های کاربر نمونه شبیه سازی شده اما معرف است.
(اختیاری - در طول GSoD2020 تصمیم گیری می شود) پیکربندی سرور همچنین ممکن است شامل پوششی معادل 389 Directory Server در FreeBSD باشد. پشتیبانی آزمایشی FreeBSD در 389 Directory Server وجود داشت اما وضعیت فعلی آن باید تأیید شود.
(3) پیکربندی کلاینت: (الف) توضیحی توضیحی از یک پیکربندی کاربردی کلاینت در FreeBSD که می تواند با اتصال سرور مثال ارائه شده در (2) متصل شود. (ب) یک مثال کامل از یک پیکربندی کاربردی کلاینت، به عنوان مثال نتیجه (3a)، در FreeBSD.
بخش پیکربندی کلاینت شامل زیربخشهایی در موارد زیر است: * ماژول تأیید اعتبار قابل اتصال (PAM)، به عنوان مثال pam_ldap، pam_mkhomedir، nss-pam-ldapd * سوئیچ سرویس نام (NSS)، به عنوان مثال nss_ldap، nss-pam-ldapd * (اختیاری - به در طول GSoD2020 تصمیم گیری شود) SSSD - وضعیت SSSD در حال تولید در FreeBSD باید تأیید شود. * (اختیاری - در طول GSoD2020 تصمیم گیری می شود) FreeIPA - استفاده و عملکرد FreeIPA در FreeBSD باید بررسی شود. FreeIPA بیش از LDAP را پوشش می دهد، بنابراین دامنه پیکربندی FreeIPA باید قبل از گنجاندن در این فصل کتابچه راهنمای ارزیابی شود.
(4) ملاحظات امنیتی * نسخه فعلی مقاله شامل بخشی در مورد ملاحظات امنیتی است. برخی از این مطالب ممکن است به بخش مربوطه منتقل شوند. با این حال، هنوز باید یک بخش اختصاصی در مورد ملاحظات امنیتی برای اهداف مرجع وجود داشته باشد.
(5) عیب یابی * استراتژی هایی برای عیب یابی پیکربندی LDAP.
(6) ضمیمه OpenSSL
با فصل/مقاله بهروزرسانی شده کتاب راهنما، خواننده میتواند دو سیستم FreeBSD تمیز را انتخاب کند، یک سرور LDAP و یک کلاینت LDAP راهاندازی کند و کلاینت را در مقابل سرور احراز هویت کند.
پس از خواندن فصل/مقاله بهروزرسانی شده کتاب راهنما، خواننده باید پایه و اساس لازم برای دریافت سایر اسناد تخصصی یا جامعتر، مانند اسناد OpenLDAP، RFCهای LDAP، و ایجاد یا اصلاح پیکربندی FreeBSD LDAP خود را برای برآورده کردن نیازهای خود داشته باشد.