Dokumentacioni servis↵

Ovaj dokument sadži detalje o dokumentacionom servisu. Opšte informacije o ovom servisu su dostupne u okviru dokumenta o osnovnim servisima.

Funkcionalnosti↵

  1. Implementirano u cross-platform, cross-browser, FOSS tehnologijama.
  2. Sadrži sve vrste dokumentacije - funkcionalnu, korisničku, administratorsku i tehničku.
  3. Ažuriranje dokumentacije u Markdown i Plantml jezicima.
  4. Eksport u više različitih formata.
  5. Konfiguracija za više različitih ciljnih grupa.
  6. Kompletno automatizovana infrastruktura.
  7. Kompletna automatizacija deploymenta na okruženje po želji i development kroz Invoke-Build skript.
  8. Automatizovani changelog:
    1. Full i user changelog sa informacijama za različite ciljne grupe
    2. Automatski update prilikom deploymenta koristeći Gitlab tikete, tagovni i milestone sistem

Organizacija repozitorijum-a↵

Kompletan source code frontend-a se fizički nalazi unutar lobe-docs direktorijuma na git repozitorijumu. Značajne putanje uključuju:

  1. docs
    Direktorijum sadrži mkdocs source code koji se izvršava korišćenjem python ekosistema.
  2. lobe-docs.build.ps1
    Sadrži Invoke-Build skript kojom se realizuju bitne uobičajne operacije u toku razvoja kao što su pokretanje servera na lokalnoj mašini, instalacija i konfiguracija prerekvizita itd.
  3. packages.ps1
    Sadrži sve prerekvizite za sve tipove izvršenja (putem tagova).
  4. infrastructure
    Direktorijum koji sadrži skripte za setup i konfiguraciju infrastrukturalnih elemenata.

Razvoj↵

Da bi se pokrenuo servis na lokalnoj stanici u LOBE Shell se izvršava ib Run komanda. Browser prikazuje promene u realnom vremenu prilikom ažuriranja dokumentacije.

Komanda se izvršava unutar lobe-docs direktorijuma u koji se pozicionira preko bookmark-a: go docs Enter+Enter.

ib ? bilo gde unutar lobe-docs direktorijuma daje listu raspoloživih razvojnih/administratorskih akcija.

Info

Svaki projekat sadrži README.md i druge .md fajlove koji sadrži detaljne tehničke informacije.