Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần tài liệu của Google.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Dự án FreeBSD
- Người viết nội dung kỹ thuật:
- Larry
- Tên dự án:
- Thông tin cập nhật về sách hướng dẫn FreeBSD
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Dự án GSoD2020 này sẽ bao gồm hai chương trong sách hướng dẫn FreeBSD:
- Kiểm thử: Chương mới trong Sổ tay dành cho nhà phát triển FreeBSD
- LDAP: Bài viết đã cập nhật được hợp nhất vào chương trong Sách hướng dẫn FreeBSD
Kiểm thử: Chương mới trong Sổ tay dành cho nhà phát triển FreeBSD:
LƯU Ý: Dự án này mang tính khám phá nhiều hơn ở giai đoạn đầu. Các yêu cầu có thể thay đổi trong giai đoạn viết.
Các nhiệm vụ chuẩn bị bao gồm: * Xem lại tài liệu hiện tại và ghi chú về các khung kiểm thử, phương pháp, v.v. dành cho nhà phát triển cho FreeBSD và(các) BSD khác. * Tài liệu và ghi chú FreeBSD hiện tại hoặc cũ hơn. Ví dụ: * TestSuite: https://wiki.freebsd.org/TestSuite * Trang ""TestingFreeBSD"" cũ: https://wiki.freebsd.org/TestingFreeBSD * Tài liệu và ghi chú hiện tại của các dự án có liên quan. Ví dụ: * http://wiki.netbsd.org/tutorials/atf/ * Tài liệu chính về các công cụ có liên quan. Ví dụ: * Khung kiểm thử Kyua: https://github.com/jmmv/kyua/ * Khung kiểm thử tự động (ATF): https://github.com/jmmv/atf/ * Cài đặt và định cấu hình các khung liên quan để làm quen. * Sử dụng khung kiểm thử để chạy các chương trình kiểm thử hiện tại. * Viết một số ít chương trình kiểm thử mới. * (RẤT quan trọng) Tham khảo ý kiến của độc giả (nhà phát triển và kiểm thử phần mềm) về những nội dung họ muốn thấy trong chương.
Tổ chức chính xác của tài liệu sẽ được xác định. Tuy nhiên, sau khi đọc chương, người đọc ít nhất phải có thể làm những việc sau:
- Cài đặt và định cấu hình các khung kiểm thử cho mục đích kiểm thử FreeBSD.
- Viết mã kiểm thử cho khung kiểm thử.
- Chạy kiểm thử trong khung kiểm thử.
Chúng tôi sẽ nhấn mạnh những nội dung sau đây (nếu có thể): * tối đa hoá tính tự động hoá để giảm công việc thiết lập cơ sở hạ tầng kiểm thử, viết kiểm thử và chạy kiểm thử. * thêm các trường hợp kiểm thử bất cứ khi nào khắc phục một lỗi mới. * kiểm thử hồi quy tự động toàn diện. * (nếu có) bao gồm các ví dụ về các tình huống kiểm thử tiêu chuẩn, chẳng hạn như kiểm thử đơn vị, kiểm thử chức năng, kiểm thử tải, v.v.
Nếu có thể, mục tiêu không chỉ là giải thích và hướng dẫn nhà phát triển thông qua khung kiểm thử mà còn hy vọng giữ cho quy trình này đơn giản nhất có thể để khuyến khích nhà phát triển tích hợp thêm hoạt động kiểm thử và nhà phát triển mới không bị ngăn cản việc đóng góp.
LDAP: Bài viết đã cập nhật được hợp nhất vào một chương trong Sách hướng dẫn FreeBSD:
Không giống như chương về Kiểm thử, phạm vi của một bài viết hoặc chương cập nhật về LDAP được hiểu rõ.
Chương hiện tại trong Sổ tay FreeBSD và bài viết hiện tại đều chứa nhiều thông tin hữu ích. Tuy nhiên, bạn cần cập nhật các thông tin này. Một bản sửa đổi mới của bài viết (dự kiến sẽ trở thành chương mới) đã bắt đầu nhưng cần phải hoàn tất.
Các nhiệm vụ bao gồm: * Kiểm tra chính tả cho chương sách hướng dẫn hiện tại và bài viết hiện tại. * Để chuẩn bị cho GSoD2020, chúng tôi đã thực hiện một lần chuyển đổi ban đầu. * Kiểm thử từng phần trong sách hướng dẫn để xác nhận những phần nào hiệu quả và những phần nào cần sửa đổi. * Để chuẩn bị cho GSoD2020, chúng tôi đã kiểm tra cấu hình máy chủ với các điểm cải tiến được xác định. * Các phần khác còn lại. * Viết nội dung mới và sửa đổi nội dung hiện tại. * Nội dung cập nhật đã được bắt đầu cho phần máy chủ. Bạn cần hoàn tất quy trình này. * Còn lại các phần khác. * Kiểm thử tất cả nội dung trên các hệ thống FreeBSD sạch sau khi bản nháp cuối cùng hoàn tất. * Nhiệm vụ này rất quan trọng vì nó xác định mọi khoảng trống.
Bài viết hoặc chương sách hướng dẫn cuối cùng dự kiến sẽ chứa các phần sau:
(1) Giới thiệu về LDAP (2) Cấu hình máy chủ: (a) Hướng dẫn từng bước giải thích về cấu hình máy chủ OpenLDAP cơ bản nhưng có chức năng trên FreeBSD. (b) Một ví dụ hoàn chỉnh về cấu hình máy chủ OpenLDAP cơ bản nhưng có chức năng, ví dụ: kết quả của (2a) trên FreeBSD.
""Cơ bản nhưng chức năng"" bao gồm cấu hình của máy chủ với mật khẩu đã băm, kết nối bảo mật qua mạng và dữ liệu người dùng mẫu được mô phỏng nhưng đại diện.
(Không bắt buộc – Sẽ được quyết định trong GSoD2020) Cấu hình máy chủ cũng có thể bao gồm phạm vi tương đương của Máy chủ thư mục 389 trong FreeBSD. Có hỗ trợ FreeBSD thử nghiệm trong Máy chủ thư mục 389 nhưng cần xác nhận trạng thái hiện tại của máy chủ này.
(3) Cấu hình ứng dụng: (a) Hướng dẫn từng bước giải thích về cấu hình ứng dụng có chức năng trên FreeBSD có thể kết nối với kết nối máy chủ mẫu được cung cấp trong (2). (b) Ví dụ hoàn chỉnh về cấu hình máy khách có chức năng, ví dụ: kết quả của (3a) trên FreeBSD.
Phần cấu hình ứng dụng sẽ bao gồm các tiểu mục về những nội dung sau: * Mô-đun xác thực có thể cắm (PAM), ví dụ: pam_ldap, pam_mkhomedir, nss-pam-ldapd * Trình chuyển đổi dịch vụ tên (NSS), ví dụ: nss_ldap, nss-pam-ldapd * (Không bắt buộc – Sẽ được quyết định trong GSoD2020) SSSD – Cần xác nhận trạng thái của SSSD trong phiên bản chính thức trong FreeBSD. * (Không bắt buộc – Sẽ được quyết định trong quá trình GSoD2020) FreeIPA – Cần điều tra việc sử dụng và chức năng của FreeIPA trong FreeBSD. FreeIPA không chỉ bao gồm LDAP, vì vậy, bạn phải đánh giá phạm vi cấu hình FreeIPA trước khi đưa vào chương sách hướng dẫn này.
(4) Những điểm cần cân nhắc về bảo mật * Phiên bản hiện tại của bài viết có một phần về những điểm cần cân nhắc về bảo mật. Một số nội dung này có thể được chuyển sang phần có liên quan. Tuy nhiên, vẫn nên có một mục dành riêng cho những điểm cần cân nhắc về bảo mật để bạn tham khảo.
(5) Khắc phục sự cố * Chiến lược khắc phục sự cố về cấu hình LDAP.
(6) Phụ lục OpenSSL
Với chương / bài viết đã cập nhật trong sách hướng dẫn, người đọc có thể lấy hai hệ thống FreeBSD sạch, thiết lập máy chủ LDAP và ứng dụng LDAP, đồng thời xác thực ứng dụng với máy chủ.
Sau khi đọc chương / bài viết đã cập nhật trong sách hướng dẫn, người đọc sẽ có nền tảng cần thiết để tham khảo các tài liệu chuyên sâu hoặc toàn diện hơn, chẳng hạn như tài liệu OpenLDAP, RFC LDAP, cũng như xây dựng hoặc tinh chỉnh cấu hình LDAP FreeBSD để đáp ứng các yêu cầu của họ.