Dokumentacja Logintegry¶
Punkt wejścia do dokumentacji workspace'u i poszczególnych repozytoriów. Wszystko jest jedną stroną: menu boczne grupuje obszary (Apollo, Mikroserwisy, Infrastruktura), dokumentacja każdego repozytorium to rozwijana grupa w swoim obszarze, a wyszukiwarka przeszukuje wszystkie repozytoria naraz.
Budowanie i podgląd lokalnie, z katalogu głównego workspace'u:
scripts/ws docs build # wszystkie repozytoria; albo: scripts/ws docs build 'ansible|parser'
scripts/ws docs serve # http://127.0.0.1:8000/
Edytując dokumentację jednego repozytorium, wygodniej uruchomić zensical serve
w jego katalogu (przeładowanie na żywo).
Zasady dokumentacji¶
Zasady dokumentacji mówią, gdzie trzymać dokumentację, jak zbudować stronę i jak pisać. Obowiązują każdą nową i edytowaną stronę.
Repozytoria¶
Każde repozytorium z kodem ma README.md i CONTRIBUTING.md.
Wzorce podają szablon README i szablon CONTRIBUTING.
Wspólny proces pracy opisuje Proces pracy.
Plany¶
| Plan | Zawartość |
|---|---|
| CI dla repozytoriów Logintegry | PR checki, jeden artefakt na wszystkie środowiska, wdrożenia jako promocja wersji |
Testy¶
Przypadki testowe w TMA opisują projekt TMA w YouTrack i jego powiązanie z testami automatycznymi.
Serwery testowe¶
Serwery testowe - adresy, panele admina, Portainer, buildy TeamCity i IP środowisk wombaty, oposy, kapibary, demo i staging, plus SSH, logi i nazwy serwisów.
Zasady pracy¶
Weryfikacja techniczna opisuje pola DEV Pre-check i QA Pre-check oraz bramki, które zatrzymują propozycję rozwiązania przed wyceną, a zadanie robocze przed planowaniem.
- Checklista weryfikacji technicznej podaje kryteria, według których DEV i QA ustawiają pola
DEV Pre-checkiQA Pre-check.
Dokumentacja repozytoriów¶
Każde repozytorium ma rozwijaną grupę w menu bocznym: własną stronę dokumentacji
albo README.md i CONTRIBUTING.md.
Apollo¶
| Dokumentacja | Repozytorium | Zawartość |
|---|---|---|
| Apollo backend | apollo/backend |
dokumentacja backendu Apollo (Grails 5) |
| Apollo API (OpenAPI) | apollo/backend |
wszystkie endpointy REST w Swagger UI - generowane z UrlMappings.groovy (./gradlew openApi) |
| Apollo frontend | apollo/frontend |
interfejs webowy Apollo (Ember) |
| Apollo admin | apollo-admin |
panel administracyjny Apollo (Grails) |
| Apollo Docker | apollo-docker |
lokalne środowisko Apollo w Dockerze |
| Infokiosk | infokiosk |
kiosk bramowy dla kierowców: przebieg obsługi, integracja z Apollo i SMS, konfiguracja, uruchomienie |
Mikroserwisy¶
| Dokumentacja | Repozytorium | Zawartość |
|---|---|---|
| Microservice Courier | microservice-courier |
integracje kurierskie |
| Microservice Parser | microservice-parser |
parsowanie plików XML do JSON-a (Kotlin); na razie README - mkdocs.yml czeka na migrację do zensical.toml |
| Mikroserwis SMS | mikroserwis-sms |
odbieranie i wysyłanie SMS-ów dla Apollo |
| Weight Gateway | weight-gateway |
odczyty wagi po TCP ze sterownika MOXA, ostatni odczyt przez HTTP dla Apollo |
Infrastruktura¶
| Dokumentacja | Repozytorium | Zawartość |
|---|---|---|
| Infrastruktura (Terraform + Ansible) | logintegra-ansible |
Terraform + Ansible na Scaleway: konfiguracja, FAQ, hosty docker-node i tomcat-node, proces DevOps, plany |
| teamcity-configuration-as-a-code | teamcity-configuration-as-a-code |
konfiguracja TeamCity w Kotlin DSL (versioned settings) |
| http-proxy | http-proxy |
reverse proxy w Node.js (Express, http-proxy-middleware) |
Narzędzia¶
| Dokumentacja | Repozytorium | Zawartość |
|---|---|---|
| logintegra-toolbox-cli | logintegra-toolbox-cli |
Toolbox Logintegry - narzędzia CLI w Pythonie |
| psql-docker-anonymizer | psql-docker-anonymizer |
odtworzenie backupu PostgreSQL w Dockerze, skrypty SQL i zrzut bazy |
| neuca-db-integration-tool | neuca-db-integration-tool |
środowisko i testy integracji współdzielonej bazy klienta Neuca (Go) |
| swagger-node | swagger-node |
Swagger dla Apollo (Node.js) |
| swiss-krono-selenium-tests | swiss-krono-selenium-tests |
testy Selenium dla Swiss Krono (Java, Maven) |
Nowe repozytorium
Wystarczy wpis w repos.txt - scripts/ws docs build doda jego README.md albo
dokumentację (zensical.toml) do grupy "Inne" w menu bocznym. Obszar, tytuł i opis
w tabeli powyżej ustawiamy w docs.toml ([[section]], [repo."<ścieżka>"]), tam też
opisujemy dokumentację generowaną (OpenAPI). Tabele generuje scripts/docs.py - tej
części strony nie edytujemy ręcznie.
Ostatnia zmiana: 2026-11-20 · Dariusz Bakowski
Zbudowano: 2026-11-20 10:32 UTC · wersja 1.0.0 · rewizja: 19fcdc12e