Uživatelská dokumentace

Celá myšlenka je o tom, moct publikovat pouze manažerskou nebo členskou sekci tak aby nekompletnost druhé nezpomalila výdání celé dokumentace a současně se při vývoji nemuselo používat složtější větvení a PR.

Obsah

Dokumentace se dělí na tři projekty:

Postup práce

Při práci se upravují se jednotlivé repozitáře, commituje se do master a automaticky s každým pushem se spouští pipeline, která danou změnu publikuje do testovacího prostředí (joby build_test a deploy_test).

Postup je možné sledovat v Git → pi-doc → Pipelines

postup

Pokud je část dokumentace (pi/ms/cs) připravena k publikaci, tak je třeba spustit manuálně joby publish_ms resp. publis_cs, které posunou větev production v daném repozitáři dokumentace.

Po vykonání předchozích jobů (jednoho, obou nebo i žádného v případě úpravy pi projektu) lze manuálně spustit job build_stage (se kterým se automaticky také pouze připraví build_prod a po provedené se spustí automaticky deploy_stage), který nahraje verzi dokumentace do testovacího prostředí k finální kontrole v tom stavu (označeného větvemi production), ve kterém se pak může nahrávat na produkci.

Po kontrole verze dokumentace lze spustit poslední manuální job deploy_prod který už pouze nahraje finální verzi na produkční prostředí.

S novým comitem do libovolného repozitáře se automaticky v testovacím prostředí opět objeví verze master.

Lokální generování

Pro vytvoření plné dokumentace (včetně vyhledávacího indexu), je potřeba mít stažené repozitáře pi/docs/pi-doc-ms a pi/docs/pi-doc-cs vedle pi/docs/pi-doc a spouštět soubor antora-playbook-local.yml

DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr antora --generator antora-site-generator-lunr --fetch antora-playbook-local.yml

Taháček

Skryté stránky

Stránky které se nemají indexovat do fulltext indexu lze vyloučit pouižtím atributu noindex v hlavičce stránce. Lze vyloučit vždy jen celou stránku.

= Osoby a uživatelé
:page-aliases: 1.0@pi:ROOT:users.adoc
:noindex: (1)


== Kdo je osoba[[osoba]]

Osobou se v systému Pohodlne.info rozumí každá evidovaná osoba, může se jednat o:
1 použití atributu noindex.