Docs FAD 2014 – jak vzniká dokumentace Fedory

Anglická zkratka FAD znamená Fedora Activity Day. Jedná se o setkání lidí přispívajících do projektu Fedora v určité oblasti. Tito přispěvatelé se sejdou obvykle na jednom místě a intenzivně pracují na předem domluvených úkolech. Jeden takový FAD se uskutečnil od 21. do 23. března 2014, a to hned na dvou místech zároveň: jedna skupina přispívajících se setkala v brněnské pobočce Red Hatu, a druhá v ústředí Red Hatu v americkém Raleigh. Pomocí služby Blue Jeans se obě skupiny propojily telemostem. Tématem setkání byla dokumentace Fedory, probíraly se tedy především záležitosti týkající se dokumentačního projektu Fedory, ale třeba také překladů.

Dokumentační projekt Fedory sdružuje přispěvatele z různých částí světa, kteří se věnují vytváření a publikování oficiální dokumentace Fedory na stránkách docs.fedoraproject.org. Podobně jako jiné open source komunitní projekty, i dokumentační projekt Fedory pociťuje stálý nedostatek dobrovolníků, kteří by měli zájem zapojit se do psaní dokumentace pro tuto oblíbenou linuxovou distribuci. Je tedy nasnadě, že hlavní náplní setkání dosavadních přispěvatelů bylo hledání způsobů, jak získat a také udržet nové zájemce o členství v projektu.

Fedora mentors

Účastníci setkání se shodli na potřebě organizovaného a systematického zaučování nováčků. Ke každému nově příchozímu zájemci by měl být přidělen zkušený člen projektu (mentor), který zájemce povede při prvních krocích, jako je výběr tématu, které chce zájemce dokumentovat, či zaučení v práci s nástroji, které jsou v dokumentačním projektu využívány k vytváření a publikování dokumentace.

Office hours

Přispěvatelé se také dohodli na organizaci pravidelných office hours, při kterých budou k dispozici na kanále #fedora-docs v síti freenode, aby v reálném čase zodpovídali dotazy nováčků a pomohli jim při zapojování se do aktivit projektu. Jedny takové office hours pro Evropu budou probíhat každou neděli od 17.00 do 18.00 hod., office hours pro oblast Ameriky pak každý čtvrtek od 20.00 do 21.00 hod. Konverzačním jazykem bude, stejně jako v případě celého dokumentačního projektu, angličtina. Kalendář s podrobnějšími informacemi naleznete na apps.fedoraproject.org/calendar/Events.

Fedora Documentation Guide

Pomůckou, která by měla usnadnit dalším lidem zapojení se do projektu, je Fedora Documentation Guide. Rozepsaná verze této příručky existuje již delší dobu, na Docs FAD se ale započalo s jejím přepracováním. Cílem je nabídnout zájemcům ucelený materiál, který jim představí samotný dokumentační projekt Fedory, jeho poslání a strukturu, a umožní rychle se naučit používat formát dokumentace DocBook, ve kterém se dokumentace Fedory píše, stejně jako nástroj Publican, který slouží k vytváření, správě a publikování dokumentace v již zmíněném formátu. V neposlední řadě by měl Fedora Documentation Guide také představit systém pro správu verzí Git, ve kterém probíhá samotný vývoj dokumentace, a Transifex, jenž je využíván pro správu překladů dokumentace.

Systém publikování dokumentace

V souvislosti s nástrojem Publican je také třeba zmínit, že celý dokumentační projekt již delší dobu plánuje přechod ze stávajícího systému publikování dokumentace, který je nepříliš vhodně založený na nutnosti manuální aktualizace centrálního úložiště v Gitu, obsahujícího všechny vydané verze příruček, včetně různých formátů (HTML, PDF, EPUB) a překladů. Úložiště má v současnosti velikost přes 8 GB a začíná se projevovat skutečnost, že Git na práci s takovou strukturou úložiště není optimalizováný. Nový systém publikování, který bude založený na nejnovější, čtvrté verzi Publicanu, nevyužívá zmíněného centrálního úložiště, a výrazně tak usnadňuje publikování stávajících dokumentů. Publikování v něm spočívá na sestavování balíčků RPM v systému Koji, který dobře znají balíčkáři Fedory.

Fedora.next

Práce mnoha lidí ve Fedoře je v poslední době vyplněná debatami nad budoucností a podobou projektu během a po vydání nadcházející verze Fedora 21. Tyto debaty zaštiťuje iniciativa nazvaná Fedora.next. Ta se do jisté míry jistě dotkne i oficiální dokumentace Fedory, a proto se členové dokumentačního projektu dohodli, že se aktivně zapojí do jednotlivých pracovních skupin, které byly v rámci Fedora.next vytvořeny, tj. např. Workstation, Server, Cloud nebo Environment and Stacks. Úkolem zástupců dokumentace v těchto pracovních skupinách bude vyhodnocování dopadů změn na budoucí podobu příruček a další poskytované dokumentace, a diskuse o těchto dopadech s ostatními přispěvateli. Ǔčastníci Docs FAD se shodli, že dokumentaci, která bude skutečně užitečná pro uživatele a nejen pro její autory, je totiž možné vyvinout jen v případě, že s ní bude při formování budoucí podoby Fedory počítáno a že bude hrát stejně důležitou úlohu jako vývoj, balíčkování, design či marketing.

Jak se zapojit?

Máte-li i vy zájem zapojit se do dokumentačního projektu Fedory, který je otevřený všem zájemcům bez ohledu na množství předchozích zkušeností s psaním dokumentace, navštivte úvodní stránku projektu, prohlédněte si seznam existujících příruček, napište nám o sobě do elektronické konference projektu, nebo se připojte na zmíněný kanál #fedora-docs v síti freenode. Můžete se také zúčastnit pravidelných meetingů, které se konají každé pondělí na #fedora-meeting, případně kanál navštivte v době výše zmíněných office hours. Členové projektu se budou těšit na virtuální shledanou!

Na závěr

Závěrem je třeba poděkovat všem účastníkům tohoto vskutku mezinárodního setkání, především Ericu „Sparks“ Christensenovi a Jarkovi Hradílkovi, kteří se ujali organizace americké, resp. české části setkání, a také společnosti Red Hat za poskytnutí prostor, techniky a občerstvení po dobu konání akce.

Vydáno s licencí Creative Commons BY-SA 3.0.

Napsat komentář

Vaše emailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *

Můžete používat následující HTML značky a atributy: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Nápověda ke komentování

Při psaní komentáře můžete využít HTML značky <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> .