Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimalizace workflow přípravy newsletteru #255

Closed
karmi opened this issue Jan 26, 2022 · 4 comments · Fixed by #256
Closed

Optimalizace workflow přípravy newsletteru #255

karmi opened this issue Jan 26, 2022 · 4 comments · Fixed by #256
Assignees

Comments

@karmi
Copy link
Member

karmi commented Jan 26, 2022

V současné době je proces publikování newsletteru Česko.Digital neefektivní a zahrnuje velké množství manuálních činností. Diskutovali jsme situaci se @zoul, a navrhujeme následující změny ve workflow:

  • Vzhledem k tomu, že obsah pro newsletter je identický s obsahem, který se publikuje v příslušném příspěvku na blogu (newsletter, blog), navrhujeme úplně zrušit repositář cesko-digital/newsletter, a jako výchozí obsah pro newsletter použít repositář cesko-digital/blog.

  • Tím odstraníme nutnost obsah připravovat dvakrát — jednou ve formátu mjml pro newsletter, jednou v Markdownu pro blog. Jediným zdrojem bude Markdown. Z hlediska formátování přijdeme pouze o dvousloupcový layout v sekci „To nejlepší z našich projektů“, což nám přijde přiměřená cena za tak radikální snížení objemu manuální práce.

  • Finální výstupy z Markdown obsahu jsou dva: a) HTML pro blog, b) HTML pro newsletter. V případě blogu se technicky nic měnit nebude. V případě newsletteru implementujeme post-processing, který z Markdown nejdřív vyrobí mjml, z něhož pak vyrobí (komplikované a ulítlé) HTML pro newsletter.

  • Post-processing implementujeme pomocí Github Actions pro a) pull requesty, b) push/merge do hlavní větve. Pull requesty pak budou sloužit k náhledu blogu i newsletteru před publikací.

  • Pro získání finálního HTML pro newsletter (copy & paste do Ecomail) chceme implementovat ovládací panel, ve výchozím zobrazení skrytý, který umožní vložení finálního HTML přímo do stránky.

Finální workflow pak bude vypadat takto:

  1. Obsah pro newsletter je připravován v Markdown, v repositáři cesko-digital/blog (příklad), pomocí Netlify CMS (nebo v editoru).

  2. Pro každou úpravu se se vytvoří pull request (příklad). Vercel automaticky nasadí preview (příklad), které umožní zkontrolovat obsah vizuálně.

  3. Na preview stránce je k dispozici ovládací panel s tlačítkem Kopírovat HTML pro newsletter, které do schránky vloží specifické HTML, připravené k přímému použití v rozhraní Ecomail, a tedy k rozesílání. Je tudíž možné získat HTML pro newsletter ještě před následnou publikací newsletteru na blog.cesko.digital, k němuž dojde zamergováním pull requestu.

Odstraňujeme tak časově náročnou práci spojenou s konverzí textu newsletteru do mjml formátu.

Technické poznámky:

  • Workflow pro publikaci HTML na webu blog.cesko.digital se nijak nemění.
  • Pro získání HTML pro newsletter potřebujeme z Markdownu vygenerovat mjml XML, a z něho následně HTML (viz stávající skript).
  • Výsledné HTML pro newsletter uložíme jako .html v sestaveném webu (pro zkopírování do stránky nebo přímé načtení v prohlížeči)
  • Zrušíme repositář zoul/cist.digital, který není používán.
  • Zavedeme automatické přesměrování na aktuální vydání na titulní stránce blog.cesko.digital. Nadále tedy nebude potřeba provádět manuální úpravy v souboru now.json (příklad).
@martinwenisch
Copy link
Contributor

9 z 10 SEO expertu nedoporucuje deployovat vystup pro email na zivy web. Uploadnul bych .html do S3 kyblicku a odkaz postnul do PR? (mame na to Akci v DevTalku). Krasne se tim oddeli to workflow emailu od workflow webu.

@karmi
Copy link
Member Author

karmi commented Jan 26, 2022

@martinwenisch , nestačí přidat danou cestu do robots.txt?

@martinwenisch
Copy link
Contributor

Zbytecna komplikace, az se do toho bodu dostaneme potunim Action, aby postla odkaz do PR. Usetri to kompletne integraci s preview.

@zoul
Copy link
Member

zoul commented Jan 27, 2022

Navrhuju tohle neřešit předem; až se k tomu dostanu, budu mít lepší představu o výhodách a možnostech a ozvu se. (Super shrnutí, díky.)

@zoul zoul self-assigned this Feb 10, 2022
@zoul zoul transferred this issue from cesko-digital/newsletter Feb 10, 2022
@zoul zoul closed this as completed Feb 14, 2022
Repository owner moved this from In Progress to Done in Prioritizace práce na webu Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants