Skip to content

Commit

Permalink
Merge pull request #42 from PyDataCZ/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
janpipek authored Oct 7, 2024
2 parents c42bbce + 58f517f commit da229a4
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Materiály pro Datový kurz PyLadies

TODO: Link na aktuální kurz
Tento repozitář slouží jako zdroj pro materiály datového kurzu, který najdeš
(ve vydání roku 2024) na adrese https://naucse.python.cz/2024/pydata-praha-podzim/.

## Instalace a spuštění

Expand Down Expand Up @@ -33,7 +34,8 @@ uv run python -m naucse serve
* Buď adresu navštiv v prohlížeči a doklikej se na kurz, nebo
* na konec adresy přidej `/course/local/` a navštiv kurz přímo.

Poznámka: ve windows mi to nefunguje :-(
Poznámka @janpipek: ve windows ani linuxu mi to nefunguje :-( Ale tím asi netřeba se
trápit.

## Publikování jedné hodiny

Expand All @@ -43,10 +45,26 @@ Balíček ZIP se všemi materiály lze vytvořit použitím skriptu:
uv run cli.py export <id-hodiny>
```

## Publikování
Ten se posílá účastnicím přes slack těsně před hodinou.

TODO: 🤯
## Publikování na web

## Větve
1. Aby se vůbec něco nahrálo na web, kurz musí být definován v repozitáři
https://github.com/pyvec/naucse.python.cz, konkrétně v souboru `courses.yaml`

TODO: Popiš!
2. Soubor `.github/workflows/main.yml` v tomto repozitáři musí definovat odpovídající
jméno větve, do které se mají materiály kompilovat (aktuálně tedy `compiled2024`)

3. Potom by mělo stačit mergovat cokoliv do větve `main`, aby se vše automaticky propsalo na web.

4. ⚠️ Nicméně ono se sice vyplodí, co se vyplodit má, ale na web nenahraje. Je potřeba to
prošťouchnout pomocí akce v hlavním repozitáři: https://github.com/pyvec/naucse.python.cz/actions/workflows/main.yml .
Ta se spustí tlačítkem "Run workflow" vpravo nahoře. Pokud by chyběla práva, @janpipek či @coobas by právo
mít měli.

Do několika minut je hotovo 🎉

## Možné problémy

- naucse nemá rádo javascript ve stránkách, předvším pak plotly výstup. Ten koliduje s šablonovacím systémem
a stránka se prostě nerenderuje. Je potřeba z notebooků toto odstranit.

0 comments on commit da229a4

Please sign in to comment.