Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Projekt FreeBSD
- Pisarz techniczny:
- Larry
- Nazwa projektu:
- Aktualizacje podręczników FreeBSD
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Projekt GSoD2020 składa się z 2 rozdziałów podręcznika FreeBSD:
- Testowanie: nowy rozdział w podręczniku FreeBSD dla programistów
- LDAP: Zaktualizowano artykuł połączony z rozdziałem podręcznika FreeBSD
Testowanie: nowy rozdział w podręczniku FreeBSD dla programistów:
UWAGA: na początku ten projekt ma charakter bardziej eksploracyjny. Wymagania mogą się zmieniać w trakcie pisania.
Zadania przygotowawcze obejmują: * Zapoznanie się z bieżącą dokumentacją oraz uwagami dla programistów dotyczącymi platform testowania, praktyk itp. dotyczących FreeBSD i innych BSD. * Aktualna lub starsza dokumentacja i notatki dotyczące FreeBSD. Na przykład: * TestSuite: https://wiki.freebsd.org/TestSuite * Stara strona „TestingFreeBSD”: https://wiki.freebsd.org/TestingFreeBSD * Aktualna dokumentacja i notatki z powiązanych projektów. Na przykład: * http://wiki.netbsd.org/tutorials/atf/ * Podstawowa dokumentacja używanych narzędzi. Na przykład: * framework testowy Kyua: https://github.com/jmmv/kyua/ * framework testowy Automated Testing Framework (ATF): https://github.com/jmmv/atf/ * Instalowanie i konfigurowanie odpowiednich frameworków w celu zapoznania się z nimi. * Korzystanie z platform testowych do uruchamiania bieżących testów. * napisanie niewielkiej liczby nowych testów. * (BARDZO ważne) Konsultacje z czytelnikami (programistami i testerami) w sprawie tego, co chcą zobaczyć w tym rozdziale.
Dokładna organizacja dokumentacji zostanie ustalona w przyszłości. Po przeczytaniu tego rozdziału czytelnik powinien być w stanie wykonać co najmniej te czynności:
- Zainstaluj i skonfiguruj frameworki testowe na potrzeby testowania FreeBSD.
- napisać test dla platformy testowej;
- Uruchom test w ramach platformy testowej.
W miarę możliwości podkreślane będą te kwestie: * maksymalizacja automatyzacji w celu zmniejszenia pracy związanej z konfigurowaniem infrastruktury testowej, pisaniem testów i ich uruchamianiem. * dodawanie przypadków testowych po naprawieniu każdego nowego błędu. * kompleksowe automatyczne testy regresji. * (w stosownych przypadkach) przykłady standardowych scenariuszy testowania, takich jak testowanie jednostkowe, testowanie funkcjonalne, testowanie obciążeniowe itp.
Staraj się nie tylko wyjaśnić i poprowadzić programistę przez proces testowania, ale też maksymalnie to ułatwić. To zachęca deweloperów do przeprowadzania większej liczby testów, a nowi deweloperzy nie zniechęcają się do wzięcia udziału w programie.
LDAP: zaktualizowany artykuł scalony z rozdziałem w podręczniku FreeBSD:
W przeciwieństwie do rozdziału o testowaniu zakres zaktualizowanego artykułu lub rozdziału na temat LDAP jest dobrze znany.
Obecny rozdział w podręczniku FreeBSD i ten artykuł zawierają wiele przydatnych informacji. Muszą jednak zostać zaktualizowane. Rozpoczęliśmy nową wersję artykułu, która ma być nowym rozdziałem, ale musi zostać ukończona.
Zadania obejmują: * korektę bieżącego rozdziału i artykułu w podręczniku. * W ramach przygotowań do wydarzenia GSOD 2020 wydaliśmy wstępną licencję. * Testowanie każdej sekcji podręcznika, aby sprawdzić, co działa, a co wymaga poprawy. * W ramach przygotowań do programu GSoD 2020 konfiguracja serwera została przetestowana ze zidentyfikowanymi ulepszeniami. * Pozostałe sekcje * pisanie nowych treści i poprawianie obecnych; * Rozpoczęliśmy aktualizowanie treści w sekcji dotyczącej serwera. Musisz go wypełnić. * Pozostałe sekcje. * Testowanie wszystkich treści na czystych systemach FreeBSD po zakończeniu ostatniej wersji roboczej. * To zadanie jest kluczowe, ponieważ pozwala wykryć wszelkie luki.
Ostateczny artykuł lub rozdział podręcznika powinien zawierać te sekcje:
(1) Wprowadzenie do LDAP (2) Konfiguracja serwera: (a) Omówienie podstawowej, ale funkcjonalnej konfiguracji serwera OpenLDAP w systemie FreeBSD. (b) Kompletny przykład podstawowej, ale funkcjonalnej konfiguracji serwera OpenLDAP, np. wyniku (2a) w ramach FreeBSD.
„Podstawowy, ale funkcjonalny” obejmuje konfigurację serwera z zaszyfrowanymi hasłami, bezpieczne połączenia w sieci oraz symulowane, ale reprezentatywne przykładowe dane użytkownika.
(Opcjonalnie – zostanie ustalone podczas GSoD 2020) Konfiguracja serwera może obejmować również równoważne pokrycie serwera katalogów 389 w FreeBSD. W serwerze katalogów 389 dostępna była eksperymentalna obsługa FreeBSD, ale jej obecny stan wymaga potwierdzenia.
(3) Konfiguracja klienta: (a) objaśnienia dotyczące konfiguracji funkcjonalnego klienta w FreeBSD, który może połączyć się z przykładowym połączeniem z serwerem podanym w punkcie (2). (b) Pełny przykład konfiguracji działającego klienta, np. wynik kroku (3a), w systemie FreeBSD.
Sekcja konfiguracji klienta będzie zawierać podsekcje dotyczące tych kwestii: * Moduł uwierzytelniania z możliwością podłączenia (PAM), np. pam_ldap, pam_mkhomedir, nss-pam-ldapd * Przełącznik usługi nazw (NSS), np. nss_ldap, nss-pam-ldapd * (Opcjonalnie – zostanie to ustalone podczas GSoD2020) SSSD – należy potwierdzić stan SSSD w środowisku produkcyjnym w systemie FreeBSD. * (Opcjonalnie – decyzja zostanie podjęta podczas GSoD 2020) FreeIPA – należy zbadać wykorzystanie i funkcjonalność FreeIPA w FreeBSD. FreeIPA obejmuje więcej niż tylko LDAP, dlatego zakres konfiguracji FreeIPA musi zostać oceniony przed uwzględnieniem w tym rozdziale podręcznika.
(4) Uwagi dotyczące bezpieczeństwa* Obecna wersja artykułu zawiera sekcję dotyczącą kwestii bezpieczeństwa. Niektóre z tych treści mogą zostać przeniesione do odpowiedniej sekcji. Należy jednak mieć do czynienia z dedykowaną sekcją dotyczącą kwestii bezpieczeństwa.
(5) Rozwiązywanie problemów: * Strategie rozwiązywania problemów z konfiguracją LDAP.
(6) Załącznik OpenSSL
Dzięki zaktualizowanemu rozdziałowi lub artykułowi w podręczniku użytkownik może utworzyć dwa czyste systemy FreeBSD, skonfigurować serwer LDAP i klienta LDAP oraz uwierzytelnić klienta na serwerze.
Po przeczytaniu zaktualizowanego rozdziału lub artykułu w podręczniku czytelnik powinien mieć podstawy niezbędne do korzystania z innej, bardziej specjalistycznej lub obszerniejszej dokumentacji, np. dokumentacji OpenLDAP, RFC LDAP, a także do tworzenia lub ulepszania konfiguracji LDAP w FreeBSD zgodnie ze swoimi wymaganiami.