# 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](<https://docs.logintegra.com/zasady-dokumentacji/index.md>) 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](<https://docs.logintegra.com/szablon-readme/index.md>) i [szablon CONTRIBUTING](<https://docs.logintegra.com/szablon-contributing/index.md>). Wspólny proces pracy opisuje [Proces pracy](<https://docs.logintegra.com/proces-pracy/index.md>).

## Plany

| Plan | Zawartość |
| --- | --- |
| [CI dla repozytoriów Logintegry](<https://docs.logintegra.com/plan-ci/index.md>) | PR checki, jeden artefakt na wszystkie środowiska, wdrożenia jako promocja wersji |

## Testy

[Przypadki testowe w TMA](<https://docs.logintegra.com/testy-tma/index.md>) opisują projekt TMA w YouTrack i jego powiązanie z testami automatycznymi.

## Serwery testowe

[Serwery testowe](<https://docs.logintegra.com/serwery-testowe/index.md>) - 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](<https://docs.logintegra.com/weryfikacja-techniczna/weryfikacja-techniczna/index.md>) 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](<https://docs.logintegra.com/weryfikacja-techniczna/checklista-weryfikacji-technicznej/index.md>) podaje kryteria, według których DEV i QA ustawiają pola `DEV Pre-check` i `QA 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](<https://docs.logintegra.com/apollo-backend/index.md>) | `apollo/backend` | dokumentacja backendu Apollo (Grails 5) |
| [Apollo API (OpenAPI)](<https://docs.logintegra.com/apollo-backend-api/index.md>) | `apollo/backend` | wszystkie endpointy REST w Swagger UI - generowane z `UrlMappings.groovy` (`./gradlew openApi`) |
| [Apollo frontend](<https://docs.logintegra.com/apollo-frontend/index.md>) | `apollo/frontend` | interfejs webowy Apollo (Ember) |
| [Apollo admin](<https://docs.logintegra.com/apollo-admin/index.md>) | `apollo-admin` | panel administracyjny Apollo (Grails) |
| [Apollo Docker](<https://docs.logintegra.com/apollo-docker/index.md>) | `apollo-docker` | lokalne środowisko Apollo w Dockerze |
| [Infokiosk](<https://docs.logintegra.com/infokiosk/index.md>) | `infokiosk` | kiosk bramowy dla kierowców: przebieg obsługi, integracja z Apollo i SMS, konfiguracja, uruchomienie |

### Mikroserwisy

| Dokumentacja | Repozytorium | Zawartość |
| --- | --- | --- |
| [Microservice Courier](<https://docs.logintegra.com/microservice-courier/index.md>) | `microservice-courier` | integracje kurierskie |
| [Microservice Parser](<https://docs.logintegra.com/microservice-parser/index.md>) | `microservice-parser` | parsowanie plików XML do JSON-a (Kotlin); na razie README - `mkdocs.yml` czeka na migrację do `zensical.toml` |
| [Mikroserwis SMS](<https://docs.logintegra.com/mikroserwis-sms/index.md>) | `mikroserwis-sms` | odbieranie i wysyłanie SMS-ów dla Apollo |
| [Weight Gateway](<https://docs.logintegra.com/weight-gateway/index.md>) | `weight-gateway` | odczyty wagi po TCP ze sterownika MOXA, ostatni odczyt przez HTTP dla Apollo |

### Infrastruktura

| Dokumentacja | Repozytorium | Zawartość |
| --- | --- | --- |
| [Infrastruktura (Terraform + Ansible)](<https://docs.logintegra.com/logintegra-ansible/index.md>) | `logintegra-ansible` | Terraform + Ansible na Scaleway: konfiguracja, FAQ, hosty `docker-node` i `tomcat-node`, proces DevOps, plany |
| [teamcity-configuration-as-a-code](<https://docs.logintegra.com/teamcity-configuration-as-a-code/index.md>) | `teamcity-configuration-as-a-code` | konfiguracja TeamCity w Kotlin DSL (versioned settings) |
| [http-proxy](<https://docs.logintegra.com/http-proxy/index.md>) | `http-proxy` | reverse proxy w Node.js (Express, `http-proxy-middleware`) |

### Narzędzia

| Dokumentacja | Repozytorium | Zawartość |
| --- | --- | --- |
| [logintegra-toolbox-cli](<https://docs.logintegra.com/logintegra-toolbox-cli/index.md>) | `logintegra-toolbox-cli` | Toolbox Logintegry - narzędzia CLI w Pythonie |
| [psql-docker-anonymizer](<https://docs.logintegra.com/psql-docker-anonymizer/index.md>) | `psql-docker-anonymizer` | odtworzenie backupu PostgreSQL w Dockerze, skrypty SQL i zrzut bazy |
| [neuca-db-integration-tool](<https://docs.logintegra.com/neuca-db-integration-tool/index.md>) | `neuca-db-integration-tool` | środowisko i testy integracji współdzielonej bazy klienta Neuca (Go) |
| [swagger-node](<https://docs.logintegra.com/swagger-node/index.md>) | `swagger-node` | Swagger dla Apollo (Node.js) |
| [swiss-krono-selenium-tests](<https://docs.logintegra.com/swiss-krono-selenium-tests/index.md>) | `swiss-krono-selenium-tests` | testy Selenium dla Swiss Krono (Java, Maven) |

> [!NOTE]
>
> **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.
