pyvec / pyvec/naucse.python.cz

Rozdělit renderování obsahu, aplikaci, a seznam kurzů

Đang mở
#494 2 bình luận 2 reaction 1 người được giao Xem trên GitHub

@encukou đang làm issue này rồi.

Từ ngày 28/11/2018.

code
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
335
Fork
119
Merge trung bình
3 giờ 6 phút
Pull request đã merge (30 ngày)
1

Mô tả

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
  • naucse bude s naucse_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í:

Hard deadline je v únoru.

Tohle blokuje (nebo řeší) všechno, čemu se chci věnovat (kromě obsahu). Zejména:

  • #342 #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
  • #424 Errors in forks break non HTML pages
  • #397 Definovat workflow s forky
  • #417 Archived run
  • Změny prezentace
    • #333 #355 Statistika na hlavní stránce
    • #377 Site improvements
    • #501 Add session description to the course page

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.