diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a79bedf..00271cd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -8,7 +8,7 @@ Našli jste chybu? Chtěli byste něco doplnit? Následující odstavce popisuj Rychlé úpravy bez instalace --------------------------- -Abyste něco změnili v textech, nemusíte nic instalovat. Obsah lze upravovat online přes `repozitář na GitHubu `_ pomocí ikony s tužkou v pravém horním rohu u každého souboru. +Abyste něco změnili v textech, nemusíte nic instalovat. Obsah lze upravovat online přes :gh-repo:`repozitář na GitHubu ` pomocí ikony s tužkou v pravém horním rohu u každého souboru. Instalace --------- @@ -46,7 +46,7 @@ Kdyby s tím byl nějaký problém, tady je `návod na kombo Sphinx + MyST `__ přeloženy na obrázky a ty se zobrazí vždy všem stejně. Mrkněte na `seznam podporovaných Emoji `__. Obrázky jsou z `Twemoji `_. +Při psaní můžete používat Emoji jako třeba |:cz:| nebo |:snake:|, ale nepište je přímo pomocí Unicode, ale za pomocí značek jako ``|:cz:|`` nebo ``|:snake:|``. Unicode znaky by se zobrazovaly na každém operačním systému jinak, ale tyto značky budou díky rozšíření :gh-repo:`emojicodes ` přeloženy na obrázky a ty se zobrazí vždy všem stejně. Mrkněte na `seznam podporovaných Emoji `__. Obrázky jsou z :gh-repo:`Twemoji `. Slack ^^^^^ @@ -101,7 +101,7 @@ CI je pouze informativní a nezabrání tomu, aby se hlavní větev dostala do R Kontrola rozbitých odkazů ------------------------- -Na repozitáři je zapojená `GitHub Action `_, která jednou denně kontroluje, zda všechny odkazy fungují. Kontrolka: +Na repozitáři je zapojená :gh-repo:`GitHub Action `, která jednou denně kontroluje, zda všechny odkazy fungují. Kontrolka: .. image:: https://github.com/pyvec/docs.pyvec.org/actions/workflows/check-links.yml/badge.svg :target: https://github.com/pyvec/docs.pyvec.org/actions @@ -117,7 +117,7 @@ Generování stránek a souborů Některé stránky a soubory se generují automaticky pomocí skriptů. Tyto skripty se spouští pomocí `GitHub Actions `_, konkrétně workflow ``generate.yml``. Tyto skripty se spouští jednou denně a generují soubory, které se pak posílají jako pull requesty do repozitáře, pokud vytvoří nějaké změny. - Generuje se ``docs/operations/boards.rst`` ze `souboru boards.toml `_ a ze šablony ``operations/boards.rst``. -- Generuje se ``docs/operations/grants.rst`` z dat na `pyvec/money `_ a ze šablony ``operations/grants.rst``. +- Generuje se ``docs/operations/grants.rst`` z dat na :gh-repo:`pyvec/money` a ze šablony ``operations/grants.rst``. - Generuje se ``docs/_static/twemoji.min.js``, abychom Twemoji měli lokálně a nemuseli se spoléhat na CDN. Kód pro generování je v ``src/pyvec_docs/cli.py``. Skripty jde pouštět např. ``uv run pyvec-docs gen-boards``. diff --git a/docs/guides/calendar.rst b/docs/guides/calendar.rst index d90d0b6..5fee363 100644 --- a/docs/guides/calendar.rst +++ b/docs/guides/calendar.rst @@ -14,7 +14,7 @@ Pravidelné akce Pravidelné akce lze přidat přes tzv. iCal export. Ten může generovat přímo vaše webová stránka (jako v případě `pyvo.cz `__), nebo jej lze vytáhnout z nějaké služby (Google Calendar, meetup.com). -URL exportu pak na náš web přidejte do souboru `static/data/events_feeds.yml `__ repozitáře `pyvec/python.cz `__ pomocí pull requestu. Po začlenění se akce objeví rovnou a následně se budou načítat samy každý den. +URL exportu pak na náš web přidejte do souboru `static/data/events_feeds.yml `__ repozitáře :gh-repo:`pyvec/python.cz` pomocí pull requestu. Po začlenění se akce objeví rovnou a následně se budou načítat samy každý den. Jednorázové akce ~~~~~~~~~~~~~~~~ diff --git a/docs/guides/meetup.rst b/docs/guides/meetup.rst index 7040957..2a1258d 100644 --- a/docs/guides/meetup.rst +++ b/docs/guides/meetup.rst @@ -40,7 +40,7 @@ Slovníček Web ^^^ -Hlavním rozcestníkem komunity je sice `python.cz `__, ale srazy mají vyhrazený svůj vlastní web, `pyvo.cz `__. Jako i všechno ostatní co se tvoří pro Python komunitu u nás, i tento web `je Open Source `__ a může do něj přispět kdokoliv. +Hlavním rozcestníkem komunity je sice `python.cz `__, ale srazy mají vyhrazený svůj vlastní web, `pyvo.cz `__. Jako i všechno ostatní co se tvoří pro Python komunitu u nás, i tento web :gh-repo:`je Open Source ` a může do něj přispět kdokoliv. Mám založit sraz? @@ -177,7 +177,7 @@ Informace na pyvo.cz ^^^^^^^^^^^^^^^^^^^^ Před každým setkáním v předstihu přidejte informace na `pyvo.cz `__. -Každý sraz je zaznamenán v `.yaml` souboru v `repozitáři na GitHubu `__. +Každý sraz je zaznamenán v `.yaml` souboru v :gh-repo:`repozitáři na GitHubu `. Na stránce pro konkrétní město je odkaz *přidat informace o dalším srazu*, který otevře stránku s předvyplněnými informacemi pro další sraz. @@ -194,7 +194,7 @@ jste-li už na našem :ref:`Slacku `, volat o pomoc v kanálu :slack:`#py Propagace ^^^^^^^^^ -Existuje Twitter účet :twitter:`napyvo`, kam lze psát cokoliv v souvislosti s vaším srazem. :ref:`Zažádejte si o přístup ` a nebojte se tam psát. Nad toto ještě existuje robot `pyvo-twitter `_, který píše na :twitter:`napyvo` automatické zprávy upozorňující na srazy. Upozorňuje ovšem jen na ty srazy, které jsou včas :ref:`potvrzené na pyvo.cz `. Jestliže zaznamenáte nějaký problém s robotem, pište do :slack:`#automatizace`. +Existuje Twitter účet :twitter:`napyvo`, kam lze psát cokoliv v souvislosti s vaším srazem. :ref:`Zažádejte si o přístup ` a nebojte se tam psát. Nad toto ještě existuje robot :gh-repo:`pyvo-twitter `, který píše na :twitter:`napyvo` automatické zprávy upozorňující na srazy. Upozorňuje ovšem jen na ty srazy, které jsou včas :ref:`potvrzené na pyvo.cz `. Jestliže zaznamenáte nějaký problém s robotem, pište do :slack:`#automatizace`. .. warning:: Tato sekce ještě není zcela připravena. @@ -347,7 +347,7 @@ V průběhu volné zábavy by bylo fajn, kdyby se k sobě účastníci pořád c Knihovnička ^^^^^^^^^^^ -Existuje tzv. `Knihovnička `__, do které můžete darovat knihy a z níž si knihy můžete půjčovat. Přestože jsou srazy v různých městech, docela se nám zatím daří knihy distribuovat a poptávky po zapůjčkách uspokojovat (velký dík za to patří především knihovníkovi `Petru Viktorinovi `__, jenž s knihami pravidelně objíždí většinu srazů v ČR). Máš-li sraz, tato Knihovnička je jednou z věcí, kterou tam můžeš docela snadno zavést a podpořit tak interakci lidí i přenos vědomostí. +Existuje tzv. :gh-repo:`Knihovnička `, do které můžete darovat knihy a z níž si knihy můžete půjčovat. Přestože jsou srazy v různých městech, docela se nám zatím daří knihy distribuovat a poptávky po zapůjčkách uspokojovat (velký dík za to patří především knihovníkovi `Petru Viktorinovi `__, jenž s knihami pravidelně objíždí většinu srazů v ČR). Máš-li sraz, tato Knihovnička je jednou z věcí, kterou tam můžeš docela snadno zavést a podpořit tak interakci lidí i přenos vědomostí. Po akci @@ -359,9 +359,9 @@ Po akci Materiály z přednášek ^^^^^^^^^^^^^^^^^^^^^ -Jako archiv informací o jednotlivých srazech jsme využívali `Lanyrd `__, ale nakonec jsme si na `pyvo.cz `__ udělali vlastní systém s databází `pyvo-data `__. +Jako archiv informací o jednotlivých srazech jsme využívali `Lanyrd `__, ale nakonec jsme si na `pyvo.cz `__ udělali vlastní systém s databází :gh-repo:`pyvo-data `. -Pokud máš nějaké slajdy nebo jiné materiály, je dobré je na stránky vašeho srazu doplnit k popisu přednášek. Může to být skoro cokoliv od odkazu na YouTube s videem z přednášky, po odkazy na slajdy ze služeb jako `Speaker Deck `__ či `SlideShare `__. Pokud ti přednášející předá slajdy ve formě souboru, převeď je pokud možno na PDF a nahraj do repozitáře `talks-archive `__. +Pokud máš nějaké slajdy nebo jiné materiály, je dobré je na stránky vašeho srazu doplnit k popisu přednášek. Může to být skoro cokoliv od odkazu na YouTube s videem z přednášky, po odkazy na slajdy ze služeb jako `Speaker Deck `__ či `SlideShare `__. Pokud ti přednášející předá slajdy ve formě souboru, převeď je pokud možno na PDF a nahraj do repozitáře :gh-repo:`talks-archive `. .. _srazy-fotky: @@ -381,7 +381,7 @@ Videa Pokud se ti povedlo natočit nějaká videa (viz :ref:`srazy-nataceni`), buď dej vědět `Petrovi Viktorinovi `__ a nebo se pokus o jejich zpracování sám/sama. - 1. Připrav prázdný adresář pro každou přednášku. S ti tím pomůže funkce ``videometadata`` nástroje `pyvodb `__: + 1. Připrav prázdný adresář pro každou přednášku. S ti tím pomůže funkce ``videometadata`` nástroje :gh-repo:`pyvodb `: .. code-block:: shell @@ -404,7 +404,7 @@ Pokud se ti povedlo natočit nějaká videa (viz :ref:`srazy-nataceni`), buď de 2. Do připravených adresářů nahraj soubory s videem – jak z kamery, tak záznamy projekce. Uprav vygenerovaný soubor ``config.yaml``, tak aby obsahoval správný název přednášky, jméno přednášejícího, datum a URL akce, stejně jako odkazy na videosoubory (pokud kamera automaticky dělí záběry do více souborů, nevadí to) a další metadata: jestli byla projekce 4:3 nebo 16:9, jestli jde o lightning talk, v jakém jazyku byla přednáška a v jakém slajdy, atd. Všechny možné volby najdeš v nápovědě níže zmíněného nástroje ``talk-video-maker``. - 3. Nainstaluj `talk-video-maker `__ a jeho závislosti – `Inkscape `__, `FFmpeg `__ a font `Signika Negative `__. Tohle s největší pravděpodobností nebude fungovat jinde než na Linuxu. Na wiki projektu je stručný `návod, jak s tím začít `__. + 3. Nainstaluj :gh-repo:`talk-video-maker ` a jeho závislosti – `Inkscape `__, `FFmpeg `__ a font `Signika Negative `__. Tohle s největší pravděpodobností nebude fungovat jinde než na Linuxu. Na wiki projektu je stručný `návod, jak s tím začít `__. .. code-block:: shell @@ -416,7 +416,7 @@ Pokud se ti povedlo natočit nějaká videa (viz :ref:`srazy-nataceni`), buď de 4. Pokud se vše podařilo, máš v aktuálním adresáři sestříhané video a k němu YAML soubor s metadaty potřebnými pro YouTube. Zkontroluj, jestli video vypadá, jak vypadat má, jestli nejsou překlepy v titulcích a jestli i na konci videa je synchronní obraz a zvuk. Pokud něco není v pořádku, pokus se najít příčinu – nejspíš to bude poškozený nebo špatně ustřižený video soubor. - 5. Pro nahrávání do `kanálu Pyvo na YouTube `__ potřebuješ vlastní Google účet. Následně požádáš `Petra Viktorina `__, aby tě přidal jako správce. Na YouTube pak budeš moci přepínat mezi svými účty, přičemž jedním z nich bude právě Pyvo. Protože ruční nahrávání je otrava, existuje nástroj `talk-video-uploader `__, který video nahraje za tebe. Při prvním spuštění tě požádá o udělení oprávnění ke konkrétnímu účtu, do kterého následně bude nahrávat všechna videa. + 5. Pro nahrávání do `kanálu Pyvo na YouTube `__ potřebuješ vlastní Google účet. Následně požádáš `Petra Viktorina `__, aby tě přidal jako správce. Na YouTube pak budeš moci přepínat mezi svými účty, přičemž jedním z nich bude právě Pyvo. Protože ruční nahrávání je otrava, existuje nástroj :gh-repo:`talk-video-uploader `, který video nahraje za tebe. Při prvním spuštění tě požádá o udělení oprávnění ke konkrétnímu účtu, do kterého následně bude nahrávat všechna videa. .. code-block:: shell @@ -428,7 +428,7 @@ Pokud se ti povedlo natočit nějaká videa (viz :ref:`srazy-nataceni`), buď de .. - 6. Po nahrání všech videí je potřeba doplnit odkazy na ně do databáze `pyvo-data `__. Příslušný fragment YAML souboru vygeneruje přímo ``talk-video-uploader``. Videa jsou při nahrávání nastavena jako neveřejná. Až YouTube video zpracuje a zkontroluješ, že je všechno v pořádku, nastav ho jako veřejné přímo z webového rozhraní YouTube. + 6. Po nahrání všech videí je potřeba doplnit odkazy na ně do databáze :gh-repo:`pyvo-data `. Příslušný fragment YAML souboru vygeneruje přímo ``talk-video-uploader``. Videa jsou při nahrávání nastavena jako neveřejná. Až YouTube video zpracuje a zkontroluješ, že je všechno v pořádku, nastav ho jako veřejné přímo z webového rozhraní YouTube. Při sdílení myslete na to, že ne každý může chtít, aby byla jeho přednáška veřejně přístupná (viz :ref:`srazy-prednasejici`). Měli byste mít od přednášejícího svolení s nahráváním a uveřejněním nebo by mělo být alespoň jasné, že si mohou vybrat. diff --git a/docs/guides/promotion.rst b/docs/guides/promotion.rst index 5ae7752..11c3f43 100644 --- a/docs/guides/promotion.rst +++ b/docs/guides/promotion.rst @@ -114,7 +114,7 @@ Komunikační kanály Kalendář na PyCon.org ~~~~~~~~~~~~~~~~~~~~~ -Na `pycon.org `__ je kalendář, kam je potřeba co nejdříve zadat datum konference. Dělá se to přidáním řádku do CSV souboru v `repozitáři na GitHubu `__. +Na `pycon.org `__ je kalendář, kam je potřeba co nejdříve zadat datum konference. Dělá se to přidáním řádku do CSV souboru v :gh-repo:`repozitáři na GitHubu `. Kromě toho existuje `Python Events Calendar `__. Aktuálně není jasné, jestli se změny v CSV výše promítnou i do něj. Proto radši navíc `pošli e-mail `__ i sem. Pozor, je nutné použít danou šablonu. diff --git a/docs/operations/grants.rst b/docs/operations/grants.rst index 59c96be..b8f9591 100644 --- a/docs/operations/grants.rst +++ b/docs/operations/grants.rst @@ -1,9 +1,9 @@ Elektronická hlasování o grantech ================================= -Od roku 2020 o grantech :term:`výbor ` hlasuje prostřednictvím repozitáře `pyvec/money `_. +Od roku 2020 o grantech :term:`výbor ` hlasuje prostřednictvím repozitáře :gh-repo:`pyvec/money`. -Hlasování o grantech probíhá :ref:`pomocí reakcí ` na GitHub Issues. Hlasování se automaticky archivují sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s `pyvec/money `_ něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml `_). +Hlasování o grantech probíhá :ref:`pomocí reakcí ` na GitHub Issues. Hlasování se automaticky archivují sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s :gh-repo:`pyvec/money` něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml `_). Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky `_ a funkčnost :ref:`přepisů `. diff --git a/docs/operations/grants.rst.jinja b/docs/operations/grants.rst.jinja index d84bb22..dccfbef 100644 --- a/docs/operations/grants.rst.jinja +++ b/docs/operations/grants.rst.jinja @@ -1,9 +1,9 @@ Elektronická hlasování o grantech ================================= -Od roku 2020 o grantech :term:`výbor ` hlasuje prostřednictvím repozitáře `pyvec/money `_. +Od roku 2020 o grantech :term:`výbor ` hlasuje prostřednictvím repozitáře :gh-repo:`pyvec/money`. -Hlasování o grantech probíhá :ref:`pomocí reakcí ` na GitHub Issues. Hlasování se automaticky archivují sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s `pyvec/money `_ něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml `_). +Hlasování o grantech probíhá :ref:`pomocí reakcí ` na GitHub Issues. Hlasování se automaticky archivují sem do dokumentace pro účely jednoduššího vyhledávání, zálohy, kdyby se s :gh-repo:`pyvec/money` něco stalo, a pro nějakou historickou evidenci. Kanonickým zdrojem pravdy ale zůstává hlasování přímo na GitHub Issues, toto je jen přepis. Skript započítává pouze hlasy od členů výboru (podle `souboru boards.toml `_). Kdyby něco nesedělo, ověřte `historii zdrojáku této stránky `_ a funkčnost :ref:`přepisů `. diff --git a/docs/operations/runbooks.rst b/docs/operations/runbooks.rst index 7283f6a..db694ed 100644 --- a/docs/operations/runbooks.rst +++ b/docs/operations/runbooks.rst @@ -150,7 +150,7 @@ Schůze výboru * Projít agendu sestavenou před schůzí. * Projít otevřené žádosti o `granty `, díky čemuž žádosti nečekají nikdy déle než měsíc. - * Projít, zda není potřeba **něco schválit** (Pull Requesty na `docs.pyvec.org `__ nebo jinde…). + * Projít, zda není potřeba **něco schválit** (Pull Requesty na :gh-repo:`docs.pyvec.org ` nebo jinde…). * Pokud zbývá čas, projít Trello nástěnku: pročesat kartičky ve sloupcech *Ke schválení*, *Doing* a *To Do* a posunout je tak, aby se shodovaly s realitou. * Potvrdit si datum a čas příští schůze. diff --git a/docs/operations/support-money.rst b/docs/operations/support-money.rst index 9cc7c35..0092aec 100644 --- a/docs/operations/support-money.rst +++ b/docs/operations/support-money.rst @@ -49,7 +49,7 @@ Na příkladu je vidět hned několik výhod tohoto modelu: .. note:: Pyvec může věci :ref:`proplácet ` jen oproti dokladu podle :ref:`sekce Účetní doklady `. Pokud vám sponzor pošle více peněz, než nakonec bylo potřeba, nelze vám je jen tak vyplatit. Můžete je ale v budoucnu čerpat na další věci pomocí :ref:`grantů `. -Na domluvu ohledně otočení sponzorských peněz můžete použít kanál :slack:`#money` na :ref:`Slacku ` nebo založit žádost na `pyvec/money `_ v podobě GitHub issue. +Na domluvu ohledně otočení sponzorských peněz můžete použít kanál :slack:`#money` na :ref:`Slacku ` nebo založit žádost na :gh-repo:`pyvec/money` v podobě GitHub issue. .. _granty: @@ -59,7 +59,7 @@ Granty Pokud na svou věc nemáte sponzora, můžete požádat Pyvec o grant. Pyvec disponuje penězi, které na jeho účtě zbyly z nevyčerpaných sponzorských darů, z neurčených darů a z přebytků hospodaření konference `PyCon CZ `__. Slovo grant může někoho děsit, ale v našem podání to není nic byrokratického. Grant můžete žádat na libovolnou záležitost, která souvisí s misí Pyvce (viz stanovy: :ref:`ucel-spolku` a :ref:`formy-cinnosti-spolku`), ať už jde o stokoruny nebo desetitisíce: nájmy, trička, samolepky, projektor... -#. Na repozitáři `pyvec/money `_ založte novou žádost (GitHub issue). Je předvyplněná otázkami, stačí na ně odpovědět. +#. Na repozitáři :gh-repo:`pyvec/money` založte novou žádost (GitHub issue). Je předvyplněná otázkami, stačí na ně odpovědět. #. :term:`Výbor` žádost zváží a :ref:`odhlasuje `, zda ji schválí nebo zamítne, a to pomocí palců přímo na žádosti. Toto se děje pro všechny žádosti minimálně jednou za měsíc na schůzi výboru, ale v závislosti na vytíženosti členů výboru se to může zvládnout i rychleji. Výbor se rozhoduje na základě mnoha faktorů, např.: @@ -73,7 +73,7 @@ Pokud na svou věc nemáte sponzora, můžete požádat Pyvec o grant. Pyvec dis .. note:: Pyvec může věci :ref:`proplácet ` jen oproti dokladu podle :ref:`sekce Účetní doklady `. Pokud vám byl udělen grant 4000 Kč, je tím míněno "proplatíme účetní doklady do výše 4000 Kč". -#. Napíšete článek na `komunitní blog `__ (`repozitář `__), kde sepíšete (případně vyfotíte) výslednou věc. Jak se to povedlo, komu to pomohlo, jakou měli radost, co se naučili apod. (viz `příklad `__). +#. Napíšete článek na `komunitní blog `__ (:gh-repo:`repozitář `), kde sepíšete (případně vyfotíte) výslednou věc. Jak se to povedlo, komu to pomohlo, jakou měli radost, co se naučili apod. (viz `příklad `__). Příspěvek na blogu je **podmínkou** jednorázových grantů. Články nám pomáhají získávat peníze od sponzorů a informují komunitu o tom, co děláme. Pokud použijete grant a článek nenapíšete, nedostanete další grant. @@ -82,7 +82,7 @@ Pokud na svou věc nemáte sponzora, můžete požádat Pyvec o grant. Pyvec dis Příklad: - Zuzka by chtěla natisknout třička pro `PyLadies `__. Na tričkách nechce loga sponzorů, takže sponzory nehledá, požádá Pyvec o grant. Na `pyvec/money `_ založí novou žádost a vyplní: + Zuzka by chtěla natisknout třička pro `PyLadies `__. Na tričkách nechce loga sponzorů, takže sponzory nehledá, požádá Pyvec o grant. Na :gh-repo:`pyvec/money` založí novou žádost a vyplní: .. code-block:: text @@ -112,7 +112,7 @@ Granty mohou být :ref:`jednorázové ` nebo paušální. Ty paušální Postup získání grantu je :ref:`stejný jako u jednorázových `, jen s tím rozdílem, že nežádáte o jednorázové peníze, ale o pravidelnou částku na měsíc. Opět platí, že Pyvec může věci :ref:`proplácet ` jen oproti dokladu podle :ref:`sekce Účetní doklady `. Grant 200 Kč/měsíc tedy znamená "proplatíme účetní doklady do výše 200 Kč měsíčně". Po získání paušálního grantu **nemusíte psát článek na blog**. (Ale můžete!) Příklad: - Lumír na `pyvec/money `_ založí novou žádost: + Lumír na :gh-repo:`pyvec/money` založí novou žádost: .. code-block:: text