Dokumentace: tříúrovňové rozložení (podle !12) #150

Merged
zelvuska merged 3 commits from docs/rozlozeni-dokumentace into develop 2026-11-10 23:25:05 +01:00
Owner

Dopsání dokumentace podle návrhu rozložení z !12 (Úvod / Témata / Reference).

  • Nová stránka docs/workflow.rst: tři instance webu (lokální, testweb, produkce), nasazování (make/deploy, make/sync_test, make/deploy_prod), větev master, 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 html projde, změněné soubory nevyvolávají varování.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LX8JE3mjgsDeKqFFMAwvt7

Dopsání dokumentace podle návrhu rozložení z !12 (Úvod / Témata / Reference). - **Nová stránka `docs/workflow.rst`**: tři instance webu (lokální, testweb, produkce), nasazování (`make/deploy`, `make/sync_test`, `make/deploy_prod`), větev `master`, 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 html` projde, změněné soubory nevyvolávají varování. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01LX8JE3mjgsDeKqFFMAwvt7
- nová stránka docs/workflow.rst (instance webu, nasazování, větve,
  postup úprav, pravidla psaní kódu)
- docs/struktura.rst: přehled aplikací, hledání view k URL, základy djanga
- docs/index.rst: rozdělení na Úvod / Témata / Reference
- README: návod na vývoj přesunut do docs, zůstal jen odkaz

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: 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, …)
Author
Owner

Aktuálně polomrtvé

Aktuálně polomrtvé
julie marked this conversation as resolved
@ -26,0 +58,4 @@
* - ``sifrovacka``
- šifrovačka (odpovědi, nápovědy)
* - ``vyroci``
- účastníci výročí
Author
Owner

výročního setkání orgů M&M

výročního setkání orgů M&M
julie marked this conversation as resolved
@ -26,0 +62,4 @@
* - ``aesop``
- export pro OPMK
* - ``api``
- autocomplete a export škol
Author
Owner

API (nepsal bych konkrétní věci, leda tak to autocomplete)

API (nepsal bych konkrétní věci, leda tak to autocomplete)
zelvuska marked this conversation as resolved
@ -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.
Author
Owner

Develop je aktuální výmysl, tak to není normálně. Takže to tu vůbec nemá být.

Develop je aktuální výmysl, tak to není normálně. Takže to tu vůbec nemá být.
zelvuska marked this conversation as resolved
@ -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``.
Author
Owner

Žádná taková pravidla nemáme.

Žádná taková pravidla nemáme.
zelvuska marked this conversation as resolved
@ -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.
Author
Owner

Také odstranit hledání issues (webaři se spolu domlouvají mimo)

Také odstranit hledání issues (webaři se spolu domlouvají mimo)
zelvuska marked this conversation as resolved
@ -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.
Author
Owner

Nebo ./manage.py show_urls

Nebo `./manage.py show_urls`
zelvuska marked this conversation as resolved
@ -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``).
Author
Owner

Testy aktuálně nic nedělají

Testy aktuálně nic nedělají
zelvuska marked this conversation as resolved
- workflow: bez develop a pravidel pojmenování větví, bez hledání v issues,
  bez make/test, zmínka o ./manage.py show_urls
- struktura: upřesněné popisy vyroci, treenode a api

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LX8JE3mjgsDeKqFFMAwvt7
OndraN approved these changes 2026-11-10 19:07:09 +01:00
OndraN left a comment

Změny dokumentace dávají smysl, přijde mi to přehlednější

Změny dokumentace dávají smysl, přijde mi to přehlednější
zelvuska merged commit afed5ecd65 into develop 2026-11-10 23:25:05 +01:00
zelvuska deleted branch docs/rozlozeni-dokumentace 2026-11-10 23:25:05 +01:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
mam/mamweb!150
No description provided.