Wiki

Updated 1,338 Days AgoPublic

Actions

Wiki

Wiki w wykonaniu Phabricatora oparte jest na Remarkupie, czyli takim nieco innym markdownie.

I w ramach uzupełnienia, cholernie polecam przeczytać sobie zalinkowaną dokumentację Remarkupa - pokazuje jak można embedować w wpisach na wiki poszczególne elementy Phabricatora

Nasze wiki wcześniej działało na dokuwiki, a wpisy z niego zostały tu przeniesione przy pomocy Łosiowej magii i dobrych chęci, czego skutkiem są niektóre wpisy, do których nie trafił jeszcze nikt z #documentation_working_group więc tabelki i inne elementy mają w poprzedniej składni, której Phabricator nie umie rozkminić.

Wiki w założeniu i według The community pattern / Hackerspace Design Patterns ma być miejscem na ogólnodostępną (w przypadku projektów) lub dostępną dla członków społeczności (w przypadku informacji organizacyjnych) dokumentację. Miejscem, do którego należy sięgnąć, gdy chcemy dowiedzieć się czegoś, co logika podpowiada nam, że powinno być gdzieś spisane. Do którego sięgniemy, zanim zapytamy.

Jak się w tym odnaleźć

Więc po kolei. Każda strona na wiki składa się z treści, bocznego paska po prawej stronie, opcjonalnego indeksu, a także historii zmian i komentarzy (której na powyższym screenie nie widać)

Boczny pasek zawiera operacje, które możesz wykonać na danym artykule:

Edit Document - Edytuj dokument. Jeśli nie zostały na niego założone jakieś nadzwyczajne polityki edycji, możesz poprawić lub dopisać coś od siebie (pod warunkiem, że Twoja zmiana ma sens)
View History - Podejrzyj historię edycji dokumentu
Publish Draft - Jeśli podczas edycji dokumentu zapisałeś/aś kopię roboczą, to w ten sposób ją publikujesz
Move Document - Przenieś dokument w inne miejsce wiki.
Delete Document - Usuń dokument
Printable Page - Pokaż wersję strony, która pozbawiona jest wszelkich przeszkadzaczy - wyświetlana jest tylko treść bez paska bocznego i historii
Subscribe / Unsubscribe - Jeśli nie masz tego dokumentu wśród zasubskrybowanych (co powoduje, że dostajesz powiadomienia o zmianach) możesz tutaj zasubskrybować, lub jeśli zasubskrybowałeś/aś - odsubskrybować.
Mute Notifications - Wycisz notyfikacje
Award Token - Dodaj reakcję (jak na FB, tylko jest więcej ikonek)
Flag For Later - Oflaguj na później - służące osobistej kategoryzacji dokumentów różnokolorowe flagi, które przypisane są do użytkownika.

Tags - przypisane projekty
Subscribers - lista osób subskrybujących zmiany w dokumencie

Indeks pod treścią strony tworzy się automatycznie i wyświetla alfabetycznie co znajduje się w hierarchii dokumentów "pod" danym dokumentem - na stronie głównej będą to wszystkie stworzone artykuły, a przykładowo tu: Phabricator będą wyświetlać się podlegające pod ten poradnik Wiki i Taski i projekty.

Indeks nie wyświetla zagnieżdżeń w nieskończoność - wyświetla do dwóch poziomów "w dół".

Przykładowo, jeśli szukamy regulaminów Regulamin usług teleinformatycznych czy Wskazówki dobrego funkcjonowania w HS-ie, to w indeksie strony głównej stronie głównej zobaczymy tylko kategorię nadrzędną Regulaminy, ale nie zawartość tej kategorii

I żeby zobaczyć co tam jest, musimy wejść w Regulaminy

Powoduje to dwie rzeczy - dobrą i złą. Dobra jest taka, ze indeks nie rośnie do niebotycznych rozmiarów, zła jest taka, że nie widać na pierwszy rzut oka wielu wartościowych artykułów - dlatego tak istotne jest, żeby wiki przekształcać w kierunku jak największej czytelności. Jeśli masz na to pomysł, podziel się z #documentation_working_group 😄