Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Tor Project
- Pisarz techniczny:
- Swati Thacker
- Nazwa projektu:
- Przepisywanie strony z instrukcją obsługi Tor
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Po konsultacji z mentorami ds. toru, aby dowiedzieć się, jakie są ich oczekiwania wobec tego projektu, proponuję następujące pomysły na ustanowienie spójnej struktury i formatu strony z podręcznikiem dotyczącym TOR (https://2019.www.torproject.org/docs/tor-manual.html.en). Dzięki temu będą one przydatne i przydatne dla użytkowników. Projekt zakończy się w ciągu 3 miesięcy, a następujące pomysły są podzielone według miesięcy.
Miesiąc 1:
Utwórz spis treści dla tej strony. W raporcie TOC znajdziesz omówienie tematu oraz nagłówki wszystkich 9 kategorii opcji konfiguracji. Pod koniec tego miesiąca użytkownicy będą mogli łatwo przechodzić do różnych kategorii konfiguracji. TOC będzie wyglądać tak:
- Przegląd – dodaj informacje o tym, gdzie TOR przechowuje konfigurację różnych kategorii opcji, o ile są one w tym samym miejscu, o nazwie i domyślnej lokalizacji pliku konfiguracji, o regułach korzystania z opcji poleceń i o tym, jak użytkownicy mogą modyfikować te opcje. Informacje z tekstu wprowadzającego możemy dołączyć w temacie FORMAT PLIKU KONFIGURACJI.
- Opcje ogólne
- Opcje klienta
- Opcje serwera
- Opcje serwera katalogowego
- Testowanie opcji sieciowych
- Opcje ograniczania ryzyka typu „odmowa usługi”
- Opcje serwera urzędu certyfikacji
- Ukryte opcje usług
- Opcje nietrwałe
Miesiąc 2:
Ta strona musi mieć na celu szybkie udzielenie odpowiedzi na pytania dotyczące działania i sposobu działania poszczególnych opcji. Obecnie nie wszystkie opcje są uporządkowane w uporządkowanym formacie, a informacje o każdej z nich są przedstawione w postaci akapitów, co sprawia, że trudno jest szybko znaleźć informacje. Wszystkie dotychczasowe informacje o opcjach trzeba uporządkować za pomocą szablonu. Do końca bieżącego miesiąca będzie obowiązywać spójny format dokumentowania istniejących opcji i wszystkich nowych opcji, które pojawią się w przyszłości. Dodatkowo taki format ułatwi użycie w przyszłości podręcznika TOR jako stron „człowiek”.
- Najpierw dodaj krótki opis każdej kategorii opcji, takiej jak Opcje serwera, Opcje klienta itd. Dzięki opisom użytkownicy będą wiedzieć, jakich opcji mogą spodziewać się w poszczególnych kategoriach.
- Utwórz szablon, aby zdefiniować spójny format dla każdej opcji. Proponuję uwzględnić w szablonie te sekcje/podsekcje.
- Nazwa: nazwa opcji, która jest dokumentowana. Przykład: BandwidthBurst
- Opis: podsumowanie składni opcji w wierszu poleceń. Przykład: BandwidthBurst N bajtów
- Opis: Opisz działanie opcji konfiguracji i wartość domyślną. Przykład: skorzystaj z tej opcji, aby ograniczyć maksymalny rozmiar zasobnika tokenów (busrt) do podanej liczby bajtów w każdym kierunku. Domyślna opcja to 1 GB.
- Wartość opcji: wymień i opisz wartości, na które dana opcja zezwala. Szczegółowo opisz, do czego służy każda z wartości i w jaki sposób użytkownik powinien ją wpisać.
Miesiąc 3:
Obecnie istnieje 9 grup/kategorii opcji konfiguracji. Aby ułatwić wyszukiwanie i ułatwić sobie wyszukiwanie, utwórz stronę indeksu z listą opcji konfiguracji posortowanych alfabetycznie w każdej z 9 kategorii. Kategorie te można uszeregować według priorytetu użycia. Najczęściej używane kategorie znajdują się na samej górze.
Po upływie 3 miesięcy możemy utworzyć odnowioną instrukcję obsługi TOR, z której użytkownicy będą mogli korzystać przy zmianie ustawień konfiguracji w TOR.