Instrukcja

Aplikacja dostępna jest pod adresem: https://dokb01-prd.netia.org/ict_docs/

Środowisko produkcyjne

Dokumentacja umieszczona jest na maszynie wraz z aplikacją na serwerze Apache.
Standardowa lokalizacja: /var/www/html/dokb01-prd/ict_docs

Środowisko deweloperskie

Lokalizacja repozytorium: \\poleczki1\DOKB\Dział Obsługi Klientów Biznesowych\COB CORPO\COB Katowice\ICT\code

Software

Dokumentacja zbudowana jest na bazie aplikacji mkdocs.

W repozytorium znajduje się plik docker-compose.yml, który umożliwia uruchomienie aplikacji w kontenerze.
Drugim sposobem jest aktywowanie środowiska wirtualnego (venv):

\ictdocs\venv\Scripts\Activate.ps1 
mkdocs serve

Tworzenie dokumentacji

Dokumentacja oparta jest o notację markdown, która standardowo kompilowana jest na HTML. Pliki można tworzyć/edytować np. za pomocą VSCode, jednak aplikacja została dostosowana do możliwości integracji z aplikacją Obsidian.

Budowanie dokumentacji

Komenda mkdocs build pozwala na skompilowanie aplikacji do kodu HTML/CSS.
Skompilowana aplikacja znajduje się w katalogu site

Zbudowana aplikacja może zostać skopiowana bezpośrednio na serwer.