Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Tor Project
- Pisarz techniczny:
- Swati Thacker
- Nazwa projektu:
- Redagowanie strony z instrukcją obsługi Tor
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Po konsultacji z mentorskimi w sprawie tego, jakie są ich oczekiwania wobec tego projektu, proponuję stworzenie 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 witryna będzie przydatna i przydatna dla użytkowników. Projekt zostanie ukończony w ciągu 3 miesięcy, a poniższe pomysły są podzielone na miesiące.
Miesiąc 1:
Utwórz spis treści dla tej strony. W tym artykule znajdziesz ogólne informacje i nagłówki wszystkich 9 kategorii opcji konfiguracji. Do końca tego miesiąca użytkownicy będą mogli łatwo przechodzić do różnych kategorii konfiguracji. Warunki korzystania z usługi będą wyglądać tak:
- Przegląd – dodaj informacje o miejscu, w którym TOR przechowuje konfigurację różnych kategorii opcji, o nazwie i domyślnej lokalizacji pliku konfiguracji, o regułach korzystania z opcji poleceń oraz o tym, jak użytkownicy mogą modyfikować te opcje. Informacje z tekstu wprowadzającego możemy załączyć w temacie FORMAT PLIKU KONFIGURACJI.
- Opcje ogólne
- Opcje klienta
- Opcje serwera
- Opcje serwera katalogowego
- Testowanie opcji sieciowych
- Opcje łagodzenia skutków ataków typu DoS
- Opcje serwera urzędu certyfikacji
- Ukryte opcje usług
- Opcje nietrwałe
Miesiąc 2:
Ta strona musi mieć na celu szybką odpowiedź na pytania dotyczące działania i sposobu działania poszczególnych opcji. Obecnie opcje nie mają uporządkowanego formatu, a informacje o każdej z nich są podane w akapitach, co utrudnia ich szybkie znalezienie. Uporządkuj wszystkie dotychczasowe informacje o opcjach za pomocą szablonu. Do końca tego miesiąca ujednolicimy spójny format dokumentów dotyczących obecnych i nowych opcji, które pojawią się w przyszłości. Dodatkowo ten format ułatwi użycie w przyszłości strony podręcznika TOR jako stron „man”.
- Najpierw dodaj krótki opis każdej kategorii opcji, na przykład Opcje serwera, Opcje klienta itd. Opisy informują użytkowników o opcjach dostępnych w poszczególnych kategoriach.
- Utwórz szablon, aby zdefiniować spójny format dokumentowania poszczególnych opcji. Proponuję uwzględnić w szablonie podane niżej sekcje/podsekcje.
- Nazwa: nazwa opcji, która jest dokumentowana. Przykład: BandwidthBurst
- Streszczenie: podsumowanie składni opcji wiersza poleceń. Przykład: BandwidthBurst N bajtów
- Opis: opisz działanie opcji konfiguracji i wartość domyślną. Przykład: użyj tej opcji, aby ograniczyć maksymalny rozmiar zasobnika tokenów (busrt) do podanej liczby bajtów w każdym kierunku. Domyślna wartość to 1 GB.
- Wartość opcji: wymień i opisz wartości, na które zezwala dana opcja. Opisz szczegółowo, do czego służą poszczególne wartości i w jaki sposób użytkownik powinien je wpisać.
Miesiąc 3:
Obecnie jest 9 grup/kategorii opcji konfiguracji. Aby ułatwić wyszukiwanie i ułatwić wyszukiwanie, utwórz stronę indeksu z listą opcji konfiguracji posortowanych alfabetycznie w każdej z 9 kategorii. Kategorie te mogą być uporządkowane według priorytetu użycia (najczęściej używane kategorie opcji znajdują się na górze).
Po 3 miesiącach będziemy w stanie przygotować odnowioną instrukcję obsługi TOR, z której użytkownicy będą mogli korzystać jako podręczne narzędzie do zmiany ustawień konfiguracji w TOR.