mkdocs.yml

site_name: BPP Deploy — dokumentacja
site_description: >-
  Dokumentacja wdrożeniowa systemu BPP (Bibliografia Publikacji Pracowników) —
  orkiestracja Docker Compose, monitoring, backupy i konfiguracja.
site_url: https://iplweb.github.io/bpp-deploy/
repo_url: https://github.com/iplweb/bpp-deploy
repo_name: iplweb/bpp-deploy
edit_uri: edit/main/docs/
copyright: MIT · IPL Web

theme:
  name: material
  language: pl
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Tryb ciemny
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Tryb jasny
  icon:
    repo: fontawesome/brands/github

plugins:
  # Polski nie jest wspieranym językiem stemmera wyszukiwarki (lunr) — używamy
  # domyślnego (en), co dla dokumentacji technicznej z dużą liczbą angielskich
  # terminów (nazwy serwisów, zmienne, komendy) działa dobrze.
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

# docs/superpowers/ trzyma wewnętrzne specy/plany — nie publikujemy ich na stronie.
exclude_docs: |
  superpowers/

# Waliduj też kotwice (#anchor) w linkach wewnętrznych — z --strict literówka w
# kotwicy (np. po polskim nagłówku) wywali build, zamiast cicho prowadzić donikąd.
validation:
  links:
    anchors: warn

nav:
  - Start: index.md
  - Instalacja:
      - instalacja/index.md
      - Linux: instalacja/linux.md
      - macOS: instalacja/macos.md
      - Windows: instalacja/windows.md
      - Pierwsze uruchomienie: instalacja/pierwsze-uruchomienie.md
  - Konfiguracja:
      - Architektura konfiguracji: konfiguracja/architektura.md
      - Struktura katalogów: konfiguracja/struktura-katalogow.md
      - SSL (manual / Let's Encrypt): konfiguracja/ssl.md
      - Multi-host: konfiguracja/multi-host.md
      - Limity zasobów: konfiguracja/limity-zasobow.md
      - PostgreSQL — wersje i upgrade: konfiguracja/postgresql.md
      - pgbouncer (pula połączeń): konfiguracja/pgbouncer.md
  - Eksploatacja:
      - Najważniejsze komendy: eksploatacja/komendy.md
      - Aktualizacje i wersje obrazów: eksploatacja/aktualizacje.md
      - Przerwa techniczna z ostrzeżeniem: eksploatacja/przerwa-techniczna.md
      - Baza danych: eksploatacja/baza-danych.md
      - Migracja bazy na stockowy postgres: eksploatacja/migracja-collation-stock-pg.md
      - Backup i rclone: eksploatacja/backup-i-rclone.md
      - Przenosiny serwera: eksploatacja/przenosiny-serwera.md
      - Wydanie: eksploatacja/wydanie.md
  - Monitoring i logi:
      - Przegląd: monitoring/przeglad.md
      - Logowanie: monitoring/logowanie.md
      - Netdata i alerty ntfy: monitoring/netdata-alerty.md
      - Wolne zapytania (slow queries): monitoring/slow-queries.md
      - Dashboardy Grafany: monitoring/dashboardy-grafany.md
  - Architektura:
      - Usługi i przepływ danych: architektura/uslugi.md
      - Rate limiting (nginx): architektura/rate-limiting.md
      - Utwardzenie brzegu (nginx): architektura/utwardzenie-brzegu.md
      - WAF (ModSecurity + OWASP CRS): architektura/waf.md
      - Healthchecks i autoheal: architektura/healthchecks-autoheal.md
      - Zadania okresowe (Ofelia): architektura/zadania-ofelia.md
  - Rozwiązywanie problemów: rozwiazywanie-problemow.md
  - Rozwój pakietu:
      - Testy: rozwoj/testy.md
      - Pre-commit hooks: rozwoj/pre-commit.md
      - Backwards compatibility: rozwoj/backwards-compatibility.md
      - Pułapki — dashboardy Grafany: rozwoj/pulapki-grafany.md
      - Pułapki — pipeline Alloy: rozwoj/pulapki-alloy.md
      - Pułapki — wdrożenie i auto-update: rozwoj/pulapki-wdrozenia.md
      - Pułapki — kompresja odpowiedzi: rozwoj/pulapki-kompresji.md