Strona internetowa OMatKo!!!

TODO

• Import aktualności ze starej strony (?)
• Podstrona ze sztabem
• Poprzednie edycje (?)
• Dokumentacja
• Layout dla tabletów i dużych ekranów
• Abstrakty w harmonogramie
• Integracja z omatko-glosuj
• Github Actions (?)

Warning

Strona jest generowana przy pomocy HUGO.

Instalacja na Windowsie (w powershell'u):

winget install Hugo.Hugo.Extended

Do jej działania potrzebny jest również node.js.

Po instalacji node'a w terminalu wpisz npm i. Jeśli node nie działa zobacz czy istnieje ścieżka w zmiennych środowiskowych.

Generowanie i publikowanie

Wygeneruj stronę przy pomocy komendy:hugo -F --cleanDestinationDir

Flaga -F wygnereuje posty z przyszłą datą publikacji.

Folder public zwiera wygenerowaną stronę.

Development

Komenda hugo server --buildDrafts --noHTTPCache uruchamia serwer http.

Podgląd strony na żywo będzie dostępny na localhost:1313.

Hugo używa motywów do tworzenia stron. Dla jednej edycji konferencji powinien istnieć jeden motyw. Aby zmienić motyw ustaw parametr theme='rok-edycji'.

Zarządzanie stroną

W pliku hugo.toml znajduje się konfiguracja strony. Znajdują się tam parametry odpowiadające za wyświetlanie konkretnych sekcji:

• harmonogramu
• zapisów
• sponsorów i patronów

Sponsorzy i patroni

Aby dodać sponsorów, wystarczy wkleić loga do folderu themes/*/static/sponsors. Sponsor główny ma własny folder main wewnątrz sponsors. Patroni dzielą się na honorowych i medialnych. Każdy z nich posiada swój własny folder:

• patroni honorowi - patrons/honorary
• patroni medialni - patrons/media

Harmonogram

Dane z harmonogramu znajdują się w folderze themes/*/data/schedule. Żeby dodać dzień, stwórz plik .yml z datą tego dnia w formacie YYYY-MM-DD.

Przykładowa zawartość pliku:

- time: "9:00" # Czas punktów programu konferencji
  events: # Lista punktów
    - name: "Nazwa wykładu"
      speaker: "Imię Nazwisko" # Opcjonalne
      location: "Miejsce wykładu" # Opcjonalne
      type: "stosowana" # Blok matematyki stosowanej #Opcjonalne
      abstract: "Jakiś losowy tekst" # Opcjonalne
    - name: "Inny wykład"
      location: "Inne miejsce wykładu"
      speaker: "dr mgr inż rehabilitowany Imię Nazwisko"
      type: "teoretyczna" # Blok matematyki teoretycznej
- time: "10:00"
  events:
    - name: "Przerwa na kawę"
- time: "20:00"
  events:
    - name: "Integracja"
    - location: "SKS"

Caution

Uwaga na wcięcie tekstu. Musi być takie same dla jednej listy atrybutów, tak jak w pythonie.

❌
- time: "9:00"
events:
      - name: "Wykład"
   author: "Jan Kowalski"

Zapisy

Linki do zapisów wstaw do parametrów:

participant_url = 'link'
speaker_url = 'inny link'
poster_url = 'kolejny link'

Sztab

W folderze data/organizers znajdują się pliki .yml z danymi sztabu. Wystarczy je wypełnić i wstawić zdjęcia do folderu themes/*/content/organizatorzy/photos. Żeby aktywować podstronę odkomentuj:

[[menus.main]]
 name = 'Organizatorzy'
 pageRef = 'organizatorzy'
 url = '/organizatorzy'
 weight = 3

Posty

Dodaj post za pomocą komendy: hugo new aktualnosci/tytul-posta.md. Możesz też użyć innych fomatów. Plik pojawi się w folderze content/aktualnosci. W pliku są metadane które po kolei oznaczają:

• date - data utworzenia posta
• publishDate - data publikacji posta która będzie widoczna na stronie
• draft - czy post jest/nie jest szkicem pamiętaj żeby zmienić to na false przy publikacji posta
• title - tytuł posta
• edition - edycja omatko

Tip

Używaj pogrubienia do zaznaczania ważniejszych informacji takich jak czas, miejsce oraz imiona i nazwiska.

Aktualizacja strony

Aby zakutalizować stronę po dokonaniu zmian, otaguj commit z nową wersją strony.

Caution

Tag musisz samodzielnie zpushować na repo przy pomocy komendy git push origin <nazwa_tagu>

Po otagowaniu, wejdź na serwer wydziału przy użyciu studenckiego vpn'a i odpal skrypt pull.sh, który pobierze najnowszą otagowaną wersje strony.

Tip

Możesz wyznaczyć czas pullowania tagu za pomocą komendy at hh:mm MM/DD -f pull.sh.

Tagowanie

Konwencja jest następująca:

v13.1.3 - edycja omatko | wersja strony | wersja poprawki

Nigdy nie używaj git push --force