Dokumentace: tříúrovňové rozložení (podle !12) #150
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/rozlozeni-dokumentace"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Dopsání dokumentace podle návrhu rozložení z !12 (Úvod / Témata / Reference).
docs/workflow.rst: tři instance webu (lokální, testweb, produkce), nasazování (make/deploy,make/sync_test,make/deploy_prod), větevmaster, postup úprav (převzatý z README), pravidla psaní kódu (editorconfig, ruff, zkratky).docs/struktura.rst: tabulka aplikací, jak najít view k URL (./manage.py show_urls, Debug Toolbar), vyplněné „Základy djanga“ (URL → view → model → Jinja2 šablona).docs/index.rst: rozdělení toctree na tři úrovně, přidané dosud nezařazené stránky (struktura,docker,css,default_doc,april).README.md: sekce „Jak web vyvíjet“ jen odkazuje do docs.Chybí: stránka o historii webu a obrázek částí Djanga.
make htmlprojde, změněné soubory nevyvolávají varování.🤖 Generated with Claude Code
https://claude.ai/code/session_01LX8JE3mjgsDeKqFFMAwvt7
@ -26,0 +36,4 @@* - ``tvorba``- ročníky, čísla, deadliny, problémy (témata, úlohy, články, pohádky)* - ``treenode``- stromová struktura obsahu čísel (zadání, vzoráky, texty, …)Aktuálně polomrtvé
@ -26,0 +58,4 @@* - ``sifrovacka``- šifrovačka (odpovědi, nápovědy)* - ``vyroci``- účastníci výročívýročního setkání orgů M&M
@ -26,0 +62,4 @@* - ``aesop``- export pro OPMK* - ``api``- autocomplete a export školAPI (nepsal bych konkrétní věci, leda tak to autocomplete)
@ -0,0 +56,4 @@------ ``master`` je to, co běží (nebo co má běžet) na produkci.- ``develop`` je vývojová větev, kam se aktuálně začleňují pull-requesty.Develop je aktuální výmysl, tak to není normálně. Takže to tu vůbec nemá být.
@ -0,0 +58,4 @@- ``master`` je to, co běží (nebo co má běžet) na produkci.- ``develop`` je vývojová větev, kam se aktuálně začleňují pull-requesty.- Na každou změnu si udělej vlastní větev (např. ``fix/neco`` nebo``feat/neco``) odbočenou z ``develop``.Žádná taková pravidla nemáme.
@ -0,0 +65,4 @@#. Stáhni si repozitář a rozběhni lokální web (viz :doc:`vyvoj`).#. Najdi si problém v issues na `Gitee <https://gitea.ks.matfyz.cz/mam/mamweb/issues>`_a/nebo se domluv s webaři, na čem bys mohl/a pracovat.Také odstranit hledání issues (webaři se spolu domlouvají mimo)
@ -0,0 +67,4 @@#. Najdi si problém v issues na `Gitee <https://gitea.ks.matfyz.cz/mam/mamweb/issues>`_a/nebo se domluv s webaři, na čem bys mohl/a pracovat.#. Udělej si novou větev (``git switch -c moje-vetev develop``).#. Najdi místo, kde se to dá opravit (pomůže :doc:`struktura`), a oprav to.Nebo
./manage.py show_urls@ -0,0 +68,4 @@a/nebo se domluv s webaři, na čem bys mohl/a pracovat.#. Udělej si novou větev (``git switch -c moje-vetev develop``).#. Najdi místo, kde se to dá opravit (pomůže :doc:`struktura`), a oprav to.#. Vyzkoušej, že to lokálně funguje, jak má (a že prochází ``make/test``).Testy aktuálně nic nedělají
Změny dokumentace dávají smysl, přijde mi to přehlednější