Merge pull request #2 from haxagoncz/howto

More docs: basics for students and teachers, assigning challenges

students/basics/index.md

@@ -1,4 +1,4 @@
-# Základní používání
+# Základní používání platformy HAXAGON
 
 Studenti jsou na platformě rozděleni do skupin, které většinou představují třídy, popřípadě skupiny, do kterých chodí. Veškerá cvičení a úkoly se zadávají právě pro určité skupiny a Žebříčky také fungují v rozsahu skupin.
 
@@ -38,10 +38,57 @@ V prostředku jsou zobrazeny aktuálně běžící úlohy, aby nebyly potřeba s
 A v neposlední řadě je zcela nahoře vidět základní statistika o postupu studenta – Celkový počet vlajek, které vyřešil a procentuální vyjádření ze všech vlajek všech zadaných úloh.
 
 ## Katalog
+
+Katalog je místo pro studenty i učitele, kde si můžou projít úlohy, které jsou zde (na rozdíl od stránky [Přehled](#prehled)) uspořádané do tematických kategorií. Každá úloha zde má krátké shrnutí, aby bylo rychle jasné, čemu se věnuje, dále pak datum, kdy ji student dostal zadanou k vyřešení a počet jejích vlajek.
+
+Vyhledávat úlohy v horní části lze jak podle jejich jména, tak i podle jména jejich kategorie. Vyhledávací políčko je možné také aktivovat klávesou `/`.  
+Po vyhledání úlohy se otevře zobrazení kategorie s rozbaleným krátkým shrnutím vybrané úlohy, aby uživatel jednoduše viděl, co dané úloze předchází a co následuje.
+
+V detailu každé kategorie jsou vidět pouze ty úlohy, které má žák zadané od svého učitele.
+
+V pravé části jsou opět statistiky o studentově postupu kategorií – Počet splněných vlajek z úloh této kategorie a jejich procentuální vyjádření k celkovému počtu vlajek v kategorii.  
+Hned pod tím je celkový počet úloh v kategorii, včetně těch, které žák nemá zadané. A jako poslední může student v pravém panelu vidět, které úlohy z těch zadaných má dokončené (číslice je zelená) a které mu ještě chybí (šedá).
+
 ## Žebříčky
+
+Žebříčky poskytují studentům okamžitou informaci o jejich postupu ve třídě nebo v soutěži. Každá splněná vlajka v úloze přidá studentovi určitý počet bodů za její úspěšné vyřešení. Zcela nahoře je vidět posledních několik vlajek, které student splnil, a kdy se tak stalo.
+
+Tři studenti s nejvyšším počtem bodů v aktuálně vybrané skupině se zobrazují na "stupních vítězů", spolu s jejich vybraným avatarem.
+
+Všichni studenti jsou také řazeni postupně v tabulce, podle svých bodů. Pro jednoduché zobrazení jsou také jejich body reprezentovány grafem – počet bodů nejlepšího studenta se ukazuje jako plný řádek, ostatní studenti mají svůj progress bar vyplněný proporcionálně k tomu. 
+
 ## Nastavení
+
+V nastavení si každý může trochu přizpůsobit platformu HAXAGON k obrazu svému. Také si zde studenti mění vzhled svého profilu.
+
+### Discord integrace
+Pro přístup na [komunitní Discord server](https://discord.gg/Z3bn4EyE3H) je potřeba ověřit, že jste skutečně uživateli HAXAGONu. Pro to se používá autorizace discord účtem.
+
+Pro propojení klikněte na tlačítko s logem Discord vlevo nahoře. To Vás přesměruje na stránky discord.com, kde povolíte přístup ke jménu Vašeho účtu. Pokud nejste v prohlížeči přihlášení do Discordu, budete se muset přihlásit.
+
+Po propojení účtů můžete pokračovat na Discord server a řídit se pokyny pro ověření napsanými v kanálu #verification.
+
+### Avatar
+Avatar si lze vybrat z několika předvytvořených možností. Nahrávání vlastních obrázků možné není.  
+Uživatelský avatar se poté zobrazuje na několika místech: V Žebříčcích, v seznamu řešitelů úlohy a učitelé ho vidí v seznamu svých studentů.
+
+### Nastavení Platformy
+Webová stránka HAXAGON je dostupná jak v češtině, tak v angličtině. Pokud někde naleznete chybějící překlad, nahlaste ho, prosím, na našem [discord serveru](https://discord.gg/Z3bn4EyE3H).
+
+### Připojení
+Někteří vybraní studenti mohou vidět v nastavení možnost změnit způsob připojení k úlohám. Možnost "VPN" se bude chovat stejně, jako doposud (je nutné si nastavit VPN do HAXAGON sítě, viz [VPN Konfigurace](#vpn-konfigurace)), možnost "Veřejná IP" poskytne studentovi při připojování možnost použít veřejnou IP jednoho ze serverů, tudíž umožňuje připojení i na zařízeních, na kterých VPN není nastavená.
+
+
 ## VPN Konfigurace
 
-## Spravovat
-### Uživatelé
-### Skupiny
+Pro připojení do úloh je potřeba využít VPN a připojit se do sítě HAXAGONu.
+
+Stránka VPN Konfigurace obsahuje všechny potřebné informace k nastavení VPN na Vašem oblíbeném operačním systému. Možnost pro váš aktuálně používaný operační systém by se měla detekovat automaticky, zvýraznit a zobrazit v seznamu na prvním místě. Pokud se toto nestane, jednoduše vyberte svůj OS ze seznamu a klikněte na tlačítko "Nastavit VPN".
+
+Poté stačí následovat kroky na stránce pro instalaci VPN klienta, import konfiguračního souboru a spuštění VPN připojení.  
+Návody pro Linux a macOS/OS X obsahují také předpřipravený shell script, který stačí vložit do příkazové řádky a spustit. Příkaz obsahuje Vaši VPN konfiguraci a automaticky Vás připojí na VPN.
+
+::: danger Pozor!
+Nikdy s nikým nesdílejte svůj `.conf` VPN soubor / QR kód pro mobilní zařízení / shell příkaz na připojení!  
+Obsahuje údaje pro připojení k HAXAGON úlohám pod Vaším účtem!
+:::

students/challenges/index.md

@@ -0,0 +1,14 @@
+
+::: info INFO ⚒
+Tato stránka není hotová a je stále v procesu psaní.
+:::
+
+Something something,
+
+
+Reference na [VPN konfiguraci](./../basics/index.md#vpn-konfigurace) pro připojení k úloze
+
+
+<!---
+TODO: rozepsat
+--->

students/index.md

@@ -14,6 +14,11 @@ features:
     title: Základy
     details: Struktura platformy a návody pro studenty
 
+  - icon: 📝
+    link: ./challenges/
+    title: Úlohy
+    details: Řešení úloh
+
   - icon: 🛠
     link: ./troubleshooting/
     title: Troubleshooting

students/troubleshooting/index.md

@@ -0,0 +1,3 @@
+::: info INFO ⚒
+Tato stránka není hotová a je stále v procesu psaní.
+:::

teachers/basics/index.md

@@ -0,0 +1,129 @@
+# Základní používání platformy HAXAGON pro učitele a lektory
+
+::: info
+Celá tato sekce předpokládá znalost funkcí platformy z pohledu studentů.  
+Pro lepší porozumnění si proto nejdříve projděte [studentskou sekci](./../../students/).
+:::
+
+# Odlišnosti od studentského rozhraní
+
+Učitelé vidí na některých stránkách více věci, než studenti. V této sekci si probereme právě tyto rozdíly.
+
+## Detail úlohy
+
+Každou úlohu si učitelé mohou spustit, stejně jako jejich žáci. Navíc ale v detailu každé úlohy mají k dispozici několik nástrojů a informací navíc.
+
+### Příručka
+
+První z nich je záložka "Příručka", která se se nachází těsně pod krátkým popisem úlohy, vedle záložek "Vlajky" a "Řešitelé". Tedy pokud ji daná úloha má definovanou. Může se stát, že autor úlohy příručku vynechá.
+
+V příručce standardně bývá opsané zadání úkolů a podrobné návody, jak postupovat při jejich řešení. Ty mohou posloužit učitelům při výkladu a vysvětlování některých metod, nebo třeba když potřebují popostrčit studenta k vyřešení některého z úkolů.
+
+### Uživatelé
+
+Druhou záložkou exkluzivně pro učitele jsou "Uživatelé". Tam jsou vypsáni věichni studenti, kteří mají úlohu zadanou.  
+Vedle každého studenta je vidět status jeho instance úlohy (<span style="color:#c8c1db">offline</span>, <span style="color:#4cc274">splněná</span>, <span style="color:#f5982c">běžící</span>, <span style="color:#4cc274">spouštění</span> nebo <span style="color:#cf3a4e">zastavování</span>).  
+U každého studenta se také zobrazuje v reálném čase počet vlajek, které splnil.
+
+Učitel má několik možností, jak spravovat instance úlohy:
+
+- U běžících instancí může zcela vpravo vybrat možnost "Zastavit běžící úlohu"
+![Screenshot tlačítka pro zastavení běžící úlohy studenta](./StopRunningInstance.png)
+
+- V levé části tabulky může zaškrtávacími políčky vybrat více studentů, kterým chce zastavit úlohu, což provede tlačítkem nad tabulkou.  
+  Toto se hodí třeba po hodině, když si studenti zapomenou vypnout úlohy - stačí zaškrtnou všechny tlačítkem v hlavičce tabulky a hromadně instance zastavit.
+
+- Nebo pokud při [zadávání úlohy](#zadavani-uloh) v počátku špatně odhadl potřebný čas, nebo prostě jen studentům čas vypršel, může všem studentům resetovat čas na plnou původní hodnotu tlačítkem nad tabulkou.
+
+### Mazání úlohy
+
+Posledním z administrativních nástrojů je možnost smazat zadanou úlohu.
+
+Tím zmizí studentům ze stránky [Přehled](/students/basics/index.md#prehled), z [Katalogu](/students/basics/index.md#katalog) a body, které za úlohu získali, se jim odečtou z žebříčků.
+
+::: warning Pozor!
+Mazání úlohy nevyžaduje potvrzení, takže pozor na ukliknutí-se –⁠ smazání úlohy smaže studentům i všechen jejich postup v dané úloze.
+<!--- 
+¨TODO: až začne tlačítko vyžadovat potvrzení, smazat tohle.
+--->
+:::
+
+
+## Katalog
+
+Na stránce katalog vidí učitelé, na rozdíl od studentů, všechny dostupné okruhy úloh. U každého okruhu navíc mají v pravém horním rohu informaci, kolik úloh je zadaných právě vybrané skupině.
+
+V detailu kategorie jsou zadané úlohy rozlišeny barvou čísla a textem "Zadáno" pod jménem každé úlohy.
+
+Více o zadávání úloh dále na této stránce v sekci [Zadávání Úloh](#zadavani-uloh).
+
+
+## Žebříčky
+
+Jediný dozdíl pro učitelské účty na stránce Žebříčky je živý záznam vlajek v horní části stránky. Učitelům se zde ukazují všechny nové vlajky všech studentů v právě vybrané skupině.
+
+
+# Zadávání úloh
+
+Proces zadávání úloh začíná v [Katalogu úloh](/students/basics/index.md#katalog). Zde si učitelé mohou projít všechny úlohy podle kategorií, prohlédnout si jejich teorii i Příručku s postupem řešení.  
+V každé kategorii je jasně vidět, které úlohy jsou již pro vybranou skupinu zadané a které ještě ne.
+
+Zadávání funguje podobnou formou, jako nákupní košíky v e-shopech: Vyberete položky (úlohy), tlačítkem "Přidat" je přidáte do Košíku, který si je pamatuje napříč celou webovou stránkou –⁠ můžete si tedy libovolně prohlížet detaily úloh. Košík také fugnuje mezi jednotlivými kategoriemi v Katalogu, můžete tedy přidat jednu úlohu z kategorie "Web", vrátit se do přehledu a vybrat další úlohu na příklad z kategorie "Crypto".  
+Pro zadání všech úloh z kategorie lze použít tlačítko nad seznamem úloh, pod popiskem kategorie.
+
+## Košík
+
+Košík vybraných úloh pro zadání se nachází v pravé části obrazovky (nebo zcela nahoře na mobilních telefonech).
+
+Na vrchu košíku je jednoduché shrnutí zadání, tedy kolik celkových úloh bude zadáno a jaký je souhrnný odhadovaný čas potřebný pro vyřešení.
+
+Dále jsou podrobnější informace o jednotlivých úlohách: Jejich jméno, počet vlajek, odhadovaná časová náročnost a štítky.  
+Pořadí, v jakém jsou zde úlohy vylistovány nemá žádný význam, je to pouze pořadí, ve kterém je učitel vybral.  
+
+Každou úlohu je možné odebrat z košíku několika způsoby:
+
+- V seznamu úloh v rámci kategorie bude mít úloha, která je v košíku, vedle sebe tlačítko "Odebrat"
+- Přímo v košíku má vedle sebe každá úloha malý červený křížek
+- Nad seznamem úloh v košíku je také možnost košík vyprázdnit tlačítkem "🗑 Vše"
+
+## Zadání délky úloh
+
+Pokud jste spokojeni se seznamem vybraných úloh pro zadání, pokračujte tlačítkem "Zadat úlohy" na spodku košíku.
+
+Na této obrazovce je možné nastavit kolik času budou mít studenti na vyřešení úloh.  
+
+Délka úlohy znamená čas, po který mají studenti povoleno mít úlohu spuštěnou a pracovat na ní, tedy čas, po který poběží servery a za který bude škola účtována.  
+Na některých úlohách je možné pracovat i bez spuštění, pokud obsahují všechny informace k řešení v popisku. Většinou je ale potřeba úlohy pro práci spouštět, aby se studenti mohli připojit na simulované zařízení.
+![Screenshot příkladu úlohy, u které zbývá pro vyřešení pouze hodina a třičtvrtě z původně zadaných dvou hodin.](./RemainingChallengeTime.png)
+
+::: tip
+Vybraný čas se aplikuje pro všechny vybrané úlohy. Pro nastavení rozdílného času pro různé úlohy je nutné zadat úlohy jednotlivě.
+:::
+
+Čas je možné vybrat buďto výberem z možností v levé části, nebo posuvníkem. Oba mají stejnou funkci.
+
+Pod délkou úloh je krátké shrnutí zadání: Které skupině budou úlohy zadány a o kterou skupinu se jedná.
+
+::: tip
+Kdykoliv během procesu zadávání je možné [změnit skupinu](/students/basics/index.md#zakladni-pouzivani-platformy-haxagon) výběrem v horní části navigačního menu stránky.
+:::
+
+<br>
+
+::: info
+V budoucnu v této sekci přibudou i další možnosti nastavení, na příklad možnost uveřejnit zadané úlohy až od zadaného data a času nebo podobné vychytávky.
+:::
+
+Pokud chcete v tomto kroku upravit, které úlohy se zadají, využijte tlačítko "1. Úkoly" zhruba vprostřed stránky pod shrnutím počtu a odhadované délky úloh.  
+![Screenshot tlačítka "1. Úkoly" vlevo od tlačítka "2. Délka trvání, pod shrnutím počtu a odhadované délky úloh."](./BackToPickingChallenges.png)
+
+<br> 
+
+Celý proces zadávání se ukončí tlačítkem "Zadat úlohy", které zpřístupní vybrané úlohy studentům. 
+
+# Správa skupin
+
+::: info INFO ⚒
+Tato stránka není hotová a je stále v procesu psaní.
+:::
+

teachers/index.md

@@ -0,0 +1,22 @@
+---
+layout: home
+
+hero:
+    name: Učitelé
+    tagline: |- 
+        Navigace platformou,
+        Úlohy – zadávání, vyhodnocování
+        
+
+features:
+  - icon: 👨‍🎓
+    link: ./basics/
+    title: Základy
+    details: Struktura platformy a návody pro učitele
+
+  - icon: 🛠
+    link: ./troubleshooting/
+    title: Troubleshooting
+    details: Řešení na běžné problémy
+
+---

teachers/troubleshooting/index.md

@@ -0,0 +1,3 @@
+::: info INFO ⚒
+Tato stránka není hotová a je stále v procesu psaní.
+:::