From 9ac931774a0880ac65c98db3f6372e70536db991 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Bedna=C5=99=C3=ADk?= <jan.bednarik@gmail.com> Date: Tue, 9 Feb 2021 12:58:40 +0100 Subject: [PATCH] majak: Readme update --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c58c3ae4..c3d144b6 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,27 @@ Rozšíření která používáme: ├── tuning = app na tuning administračního rozhraní Majáku └── users = app s custom user modelem a SSO, apod. +Poznámky k uspořádání: + +* nesdílíme a nemícháme modely zděděné z `Page` mezi jednotlivými appkami a weby, + abychom předešli rozbití cizího webu +* části definice tříd stránek sdílíme jako mixin pattern (`shared.models.ArticleMixin`, + `share.models.SubpageMixin`, apod.) +* sdílet se mohou obyčejné Django modely z `models.Model`, ale umístěné v nějaké + appce/knihovně určené pro sdílení (`shared`, `calendar_utils`, apod.), nikoliv + mezi weby (mezi appkami na weby by nikdy neměly vzniknout závislosti) + +### Konfigurace webu + +Konfigurace konkrétního webu (odkazy do patičky, Matomo ID, apod.) se definuje v +kořenové `xxxHomePage` webu. Je to pro uživatele snažší na správu než +[Site Settings](https://docs.wagtail.io/en/stable/reference/contrib/settings.html) +Wagtailu pro konfigurace webů. A pro vývojáře je to skoro jedno. + +Z různých podstránek webu se k té konfiguraci dostaneme přes property `root_page` +kterou přidává `shared.models.SubpageMixin`. V `xxxHomePage` webu je třeba +definovat `root_page` tak, aby vedla na `self`. + ### Styleguide Některé weby využívají [Pirátskou UI styleguide](https://gitlab.pirati.cz/to/weby/ui-styleguide) @@ -129,7 +150,6 @@ Doména či subdoména se musí nakonfigurovat v: * environment proměnné `DJANGO_ALLOWED_HOSTS` * proxy před Majákem -* SSO Client redirect URIs ## Vývoj -- GitLab