-
Notifications
You must be signed in to change notification settings - Fork 119
Description
Aktuálně naucse není v dobrém stavu. Všechno souvisí se vším, a udělat nějaké změny a vylepšení je složité až nereálné. Rozplést to je těžší než se zdá. Zároveň je to frustrující pro lidi, kteří by se chtěli zapojit.
V posledních měsících mě zavalila práce, tak se to moc nepohnulo. Teď na to mám dedikovaný čas. Budu sem postupně psát, jak se posouvám.
(Kód je v mojí větvi, ale rozhodně není ve stavu, kdy bych chtěl aby se na to někdo díval nebo to kritizoval.)
Toto je refaktorování. Výstup bude nezměněný, takže se bude líp dělat review a na nic důležitého nezapomenu. (Opravy chyb a UX přijdou pak.)
Co plánuju v této fázi:
- Rozdělení do tří knihoven:
- Renderování obsahu –
naucse_render
- Webová aplikace –
naucse
- Obsah –
naucse.python.cz
- Renderování obsahu –
naucse
bude snaucse_render
komunikovat přes verzované a validované JSON API (a HTML – žádný Markdown).naucse
bude poskytovat verzované a validované JSON API (nástrojům jako je odevzdávátko úkolů nebo zpětnovazebník).- Když se nepodaří vyrenderovat jednu stránku, spadne build celého kurzu. (Teď spadne úplně celý build. Později se použije starší verze toho jednoho kurzu, a přestanu požadovat přístup k všem repozitářům s obsahem.)
Co mě od toho aktuálně dělí:
- Renderování notebooků
- Renderování odkazů
- Renderování seznamů materiálů
- Renderování seznamu kurzů
- Renderování kanonických lekcí
- Doladění API
- Doladění modelů
- Renderování forků
- Sanitizace inline CSS – Unify CSS sanitization for page style and <style> tags #503
- Cover page
- Opravy existujících forků
- Dokumentace
- README
- meta course
- Dokumentace API
- Zrušení nepoužitého kódu
- Testy
- Fix the xfail
- Remove test_forks.py. (I'd like to go through it once more before that).
- Dokumentace kódu
Hard deadline je v únoru.
Tohle blokuje (nebo řeší) všechno, čemu se chci věnovat (kromě obsahu). Zejména:
Cython: Use proper Czech quotes #342 Course static files #491 Course static files- Caching (incl. using old course data if current data is wrong/invalid)
- #480 Testování validity YAML souborů při buildu
- #460 Unability to freeze the website if no runs have calendar
- #444 Make lesson number/name available in the pages
- #439 Review validation of src/href
- #438 Validate all HTML/Markdown from forks
- Errors in forks break non HTML pages #424 Errors in forks break non HTML pages
- Definovat workflow s forky #397 Definovat workflow s forky
- #417 Archived run
- Změny prezentace
- Sort past runs by year in descending order #333 Add some statistics to the landing page #355 Statistika na hlavní stránce
- #377 Site improvements
- Add session description to the course page #501 Add session description to the course page