หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- The FreeBSD Project
- นักเขียนเชิงเทคนิค
- แลร์รี่
- ชื่อโปรเจ็กต์:
- การอัปเดตคู่มือ FreeBSD
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
โปรเจ็กต์ GSoD2020 นี้จะประกอบด้วย 2 บทในคู่มือ 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 พื้นฐานที่ใช้งานได้อย่างสมบูรณ์ เช่น ผลลัพธ์ของ (2ก) ใน FreeBSD
""พื้นฐานแต่ใช้งานได้"" ประกอบด้วยการกำหนดค่าเซิร์ฟเวอร์ด้วยรหัสผ่านที่แฮช การเชื่อมต่อที่ปลอดภัยผ่านเครือข่าย และข้อมูลผู้ใช้จำลองที่แสดงตัวอย่าง
(ไม่บังคับ - กำหนดในระหว่าง GSoD2020) การกําหนดค่าเซิร์ฟเวอร์อาจรวมถึงความครอบคลุมที่เทียบเท่าของเซิร์ฟเวอร์ไดเรกทอรี 389 ใน FreeBSD ด้วย มีการรองรับ FreeBSD แบบทดลองในเซิร์ฟเวอร์ไดเรกทอรี 389 แต่ต้องยืนยันสถานะปัจจุบัน
(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 2 ระบบที่ไม่มีการแก้ไขใดๆ ตั้งค่าเซิร์ฟเวอร์ LDAP และไคลเอ็นต์ LDAP รวมถึงตรวจสอบสิทธิ์ไคลเอ็นต์กับเซิร์ฟเวอร์ได้
หลังจากอ่านบท / บทความในคู่มือฉบับปรับปรุง ผู้อ่านควรมีพื้นฐานที่จำเป็นในการอ่านเอกสารประกอบอื่นๆ ที่เฉพาะเจาะจงหรือครอบคลุมมากขึ้น เช่น เอกสารประกอบ OpenLDAP, RFC ของ LDAP และสร้างหรือปรับแต่งการกำหนดค่า FreeBSD LDAP ให้เป็นไปตามข้อกำหนด