verze 2021-03-13

Kontakt/garant: Martin Ukrop ([email protected])

Pro editory obsahu

Tento postup je zjednodušený pro editory obsahu jednotlivých jazykových mutací (tj. lidi, kteří nepotřebují upravovat kostru webu v repozitáři web-core).

Co připravit na lokální vývoj?

• Návod pro instalaci a lokální vývoj najdete v ReadMe na GitHubu.

• Je dobré si v gitu nastavit jméno a email:

  git config [user.name](<http://user.name/>) "Jméno Příjmení"
  git config user.email "jmeno.prijmeni[@faktaoklimatu.c](<mailto:[email protected]>)z"
  

• Vězte, že je dostupná dokumentace k tomu, jak psát náš webu. Rozhodně nečtěte dopředu, jen si zapamatujte, kam se dá sáhnout:

  • https://kramdown.gettalong.org/syntax.html (MarkDown syntaxe)
  • https://jekyllrb.com/docs/pages/ (Jekyll, tedy např. front matters, data files, celá struktura webu)
  • https://shopify.github.io/liquid/ (Liquid, tedy syntaxe for-cyklů, proměnných, filtrů , apod.) a jeho rozšíření v Jekyllu: https://jekyllrb.com/docs/liquid/

faktaoklimatu/web-cz

Jak vypadá základní průběh vývoje?

1. Aktualizujete si lokální verzi git repozitáře (git checkout master && git pull).
2. Vytvořte si samostatnou větev z aktuální produkční verze (git checkout -b moje-nova-vetev).
   • Poznámka: Bude-li mít větev název začínající preview-, bude se z ní automaticky generovat i online verze pro interní sdílení. URL této interní verze naleznete naspodu build logu nebo na Google Firebase v záložce Hosting (nebo se zeptejte Martina).
3. Udělejte potřebné změny (úpravy textu, infografik, ...).
4. Sestavte si stránky lokálně a zkontrolujte svoji práci vizuálně (make local -j4).
5. Spusťte lokální testy (make check).
   • Poznámka: Nejprve se pouští testy na naše stránky, které musí projít. Pak se pouští kontrola dostupnosti externích odkazů, která nemusí projít (ani neprochází, jelikož některé stránky nejsou úplně zodpovědně dostupné...).
6. Udělejte commit své práce, podívejte se na konvence níže (git add <zmenene-soubory>, pak git commit).
7. Odešlete své změny na GitHub server (git push).
8. Založte pull request na GitHubu a označte vhodné lidi pro kontrolu vaší práce.
   • Poznámka: Přidáváte-li nový obsah nebo opravu, kterou je potřeba udělat i na slovenské verzi webu (a neděláte ji sami obratem), přidejte na pull request štítek PR: nový obsah pro SK resp. PR: oprava pro SK.

Jak vypadá základní průběh vývoje ve VSCode?

Příprava:

V nastavení VSCode si zapni vlastnost git.rebaseWhenSync

S gitem se pracuje v bočním panelu v této sekci:

Pro každý pull request:

1. Přepni si ve web-cz na větev master a zmáčkni ↻