Dokumentace

Kaloko

Stáhnout
Markdown s obrázky (.zip)Složka pro Docusaurus (.zip)Složka pro VitePress (.zip)Složka pro MkDocs (.zip)HTML pro offline čtení (.zip)PDFNovinky jako JSON
Stránky
▶ Projít krok za krokem

Jak Kaloko odpovídá vašim aplikacím

Jeden repozitář je málokdy jedna aplikace. V monorepu bývá aplikací několik, jedna aplikace se táhne přes víc repozitářů, agentura má projekt pro každého klienta a každý tým pojmenovává prostředí jinak. Kaloko proto pracuje s několika pojmy, které jednou přiřadíte ke své situaci.

Pojmy

PojemCo to jeObvyklé přiřazení
Organizaceúčet vaší firmy nebo agenturyjedna na firmu
Produktto, co se vydává a verzuje jako celek, s vlastním changelogem a dokumentacíe‑shop, administrace, mobilní aplikace, balíček
Projektjednotka práce a přístupu: kdo ho vidí a kdo ho kontrolujeklient, tým, modul, celá aplikace
Modulčást produktu s vlastní sekcí v dokumentaci a changelogukošík, účet, fakturace
Scénář a krokflow a jeho obrazovkypatří k projektu; může uvést produkt a modul
Prostředíkde flow běžílocal, preview, staging, produkce, production-cz
Verzevydaná verze produktuz git tagů, package.json, vašeho nástroje na release nebo z kaloko release

Produkty jsou volitelné

Bez produktů je produktem projekt a jeho changelog je changelog projektu. Tak začíná většina týmů. Až budete potřebovat víc, vypište produkty pod products: v kaloko.config.yml a scénáře uvedou svůj přes product: a module:. Nic se nemusí přesouvat.

Projekt může pokrývat několik produktů a na jednom produktu může pracovat víc projektů. Dokumentace a záznamy v changelogu odkazují na kroky, takže produkt a modul znají ze scénáře.

Verze patří produktům

Prostředí jen říká, kde běh proběhl. Běh je svázaný s verzí produktu a dokumentace pro verzi 2.4 ukazuje přijaté běhy verze 2.4. Obrázky pocházejí z prostředí, které produkt určí jako referenční (reference_env), třeba staging u interního nástroje nebo production-cz u portálu jen pro Česko.

Čtyři obvyklá uspořádání

  1. Jedna aplikace, jeden tým. Žádné produkty; projekt je aplikace a má jeden changelog. To je výchozí stav.
  2. Monorepo s několika aplikacemi. Produkt pro každou aplikaci; projekty podle týmů nebo aplikací.
  3. Agentura. Projekt pro každého klienta a produkt pro každou dodávku. Hosté od klienta čtou jen changelog a dokumentaci svého produktu.
  4. Velká aplikace s moduly. Jeden produkt s moduly podle týmů. Každý tým se stará o dokumentaci svého modulu a release má jeden společný changelog se sekcí pro každý modul.

kaloko init navrhne produkt pro každou aplikaci, kterou najde: pro každou složku v apps/ s vlastním package.json a pro složky workspaces (npm, Yarn nebo pnpm) a packages/, které se spouštějí jako aplikace (mají skript dev, start nebo serve). Sdílené knihovny vynechá. kaloko products sync je pošle do Kaloka ještě před prvním vydáním a Produkty v menu aplikace ukážou každý produkt, který čtete.

Stránka Produkty
Stránka Produkty · cs · desktop

Odebrání produktu

Produkt, který už nevydáváte, se archivuje, nemaže. Spusťte kaloko products remove <product>, nebo otevřete jeho novinky, sjeďte k nastavení na konci a zvolte Archivovat produkt. Smí to jen admin projektů produktu (u produktu celé organizace admin organizace).

Archivovaný produkt zmizí z Produktů a jeho novinky, dokumentace i veřejná stránka hlásí, že neexistují. Vydání a dokumentace zůstanou uložené. kaloko products sync ho znovu nezaloží a napíše, že je archivovaný, takže ho smažte i z products: v kaloko.config.yml. Když si to rozmyslíte, kaloko products restore <product> ho vrátí tak, jak byl. kaloko products list archivované produkty vyjmenuje.

Každá část funguje sama

Můžete používat jen changelog, jen dokumentaci, jen dokumentaci jednoho modulu, jen obrázky pro web s dokumentací, který už máte (kaloko export), nebo jen e‑mail „Co je nového“. Nic nevyžaduje celou sadu.

Na této stránceNa této stránce