nicki-krizek/tul-szz-it-nv

Vypracovávání materiálů a formátování

johnymachine opened this issue · 2 comments

johnymachine commented

Workflow

  1. Podívám se do seznamu okruhů #3
  2. Vyberu si nezabranou otázku (nemá žádné piktogramy a checked) a založím si issue s krátkým jménem otázky(dále použito jako jméno souboru a hlavní nadpis otázky).
  3. Do seznamu otázek přidám piktogram a odkaz na issue (xx. ✏️ Text otazky #7)
  4. Issue si přidělím a přidám hlavičku viz #9
  5. Po vypracování práci nahraju a změním piktogramy na ⌛ (otevřeno k diskuzi review)
  6. Kdokoliv chce provést review si také přidělí issue, vyplní se v hlavičce a zkontroluje texty.
  7. Po dokončení review, kdy už je okruh víceméně hotový, lze stav označit 👀. Tím se dá najevo, že se čeká na případná další vylepšení / feedback.
  8. Pokud je vše dokonalé, změní se příslušné piktogramy na ✅ a původní autor issue uzavře, současně s tím zašktne check před otázkou.

Git tutorial

Repozitář je třeba naklonovat přes SSH, abyste mohli pushovat změny zpět. K tomu si musíte vygenerovat klíče a přidat k github acc.

Potom lze pracovat zhruba takto (pokud jste ve větvi master).

mkdir xx_text_otazky  # vytvorim adresar pro otazku
# nejak vytvorim soubor s otazkou, podstatna je pripona .md
touch xx_text_otazky/xx_text_otazky.md  # pripadne treba vytvorim soubor v editoru
git pull origin master  # stahnu si aktualni verzi
git add :/ -A  # pridam vsechny zmeny, vcetne pripadnyho odstraneni souboru
git commit -m "zprava"  # commitnu zmeny
git push origin master  # nahraju do github repa

Formát

➡️ Každá vypracovaná otázka by měla začínat krátkým nadpisem první úrovně s číslem a přesným zněním otázky. Následuje citace s kompletním popisem otázky, viz již vypracované.

➡️ Text je formátovaný jako markdown, tahák je třeba zde: http://assemble.io/docs/Cheatsheet-Markdown.html/

Základní syntaxe:

# Nadpis 1
## Nadpis 1.1
### Nadpis 1.1.1

> citace

*kurziva*
**tucne**

- necislovany
- seznam

1. cislovany
2. seznam

`zvyrazneni kodu`

![Alternativni text obrazku](url_obrazku)

[Nazev odkazu](url_odkazu)

➡️ Jednotlivé otázky jsou členěné do samostatných složek, které obsahují i další materiály (obrázky atd.). Na obrázky je možné odkazovat relativně a měli by mít název ve formátu xx_pekny_popisek.png. Preferovaný formát je png protože je celkem do brý na text popisků a svg nefunguje dobře. V případě potřeby je možné převést online.

➡️ Můžete vyzkoušet různé editory s náhledem, ale pozor na výsledný syntax. Mě se osvědčil MarkdownPad2, ale ten ve Windows 10 blbne. Takže teď zkusím MarkPad. Je to dobré na odladění vzhledu.

➡️ Některé místa je možné vhodně obohatit o emoticony. Ale pouze v rámci technické dokumentace, takhle spíš ne... :godmode:
EDIT: Emotcony se špatně generují do pdf, používat pouze v issues.

➡️ Vložený obrázek by tedy měl odkazovat na svou lokální kopii s rozumným názvem a v titulku by měl být uvedený popisek, který je zopakován pod obrázkem se zvýrazněním italics.

➡️ Pokud je potřeba matematická formulka, stačí použít eqn editor a úplně dole vybrat URL encoded, což vygeneruje url k obrázku. Dále je dobré vybrat jako formát svg (vektorový a lépe čitelnější). Pokud by v budoucnu přestala stránka fungovat, vždycky jsou k dispozici původní LaTeX formule, ze kterých to lze opět vygenerovat. Pokud výraz obsahuje zřetězené indexy, nebo je špatně čitelný, doporučuji změnit font na větší velikost.

c^2 = a^2 + b^2

lze vložit jako

![c^2 = a^2 + b^2](https://latex.codecogs.com/svg.latex?%5Clarge%20c%5E2%20%3D%20a%5E2%20+%20b%5E2)

➡️ Na tabulky se hodí použít generátor. Tenhle podporuje i ctrl-v, což přijde celkem vhod.

nicki-krizek commented

Fun fact: Jsme nejaktivnejsi od 11:00 do 22:00, rano nikdo nedela :D

https://github.com/tomaskrizek/tul-szz-it-nv/graphs/punch-card

michalmuzicek commented

gee I wonder why :D