Spletna stran Akademije FRI

Dobrodošli na repozitoriju izvorne kode spletne strani Akademije FRI.

Spletna stran je izdelana z uporabo statičnega generatorja Hugo. Vsebina veje (angl. branch) master se samodejno objavi na spletnem naslovu https://akademijafri.si z uporabo Netlify.

Build with ❤️ using Hugo.

Urejanje vsebine

Vsebino je možno urejati na dva načina.

1. Da kontaktirate vzdrževalca spletne strani (Alenko Bone)
2. Lastno, z uporabo GitHub Pull Request

Kako poteka lastna sprememba vsebine?

Na kratko:

1. Pripravite lokalno okolje
2. Naredite fork repozitorija na GitHub
3. Z uporabo git, klonirajte fork repozitorija
4. Uredite vsebino ter lokalno preverite
5. Z uporabo git, ustvarite commit ter ga potisnete na svoj fork repozitorija (git push)
6. Na GitHub strani vaše kopije (fork) repozitorija, ustvarite pull request (zahtevek za spremembo)
7. Vzdrževalec spletne strani bo vaše spremembe pregledal ter potrdil. O tem boste obveščeni preko emaila.

Priprava lokalnega okolja

Zunanje programske odvisnosti

Programske pakete, ki jih boste potrebovali:

• Hugo (navodila za namestitev)
• GNU Make

Samo za produkcijo:

• ImageMagick

Lokalno zaganjanje strani

Odprite terminal in se primaknite v repozitorij (cd <pot do repositorija>/akademija-fri-www)

Z uporabo ukaza:

make

boste zagnali lokalni strežnik na http://localhost:1313. Spremembe vsebin spletne strani boste lahko v živo si ogledali na prejšnji povezavi.

Struktura repozitorija

Hugo preslika datoteke Markdown v HTML za spletno stran. Lahko si pogledate kratka navodila za sintakso Markdown.

Vsebina spletne strani je v direktoriju content.

Zaradi večje fleksibilnosti, ko se sklicujete na ostale vire spletne strani, spustite domeno akademijafri.si. To seveda ne velja, ko se sklicujemo na zunanje spletne strani (e.g. fri.uni-lj.si). Torej ne https://akademijafri.si/foo/bar, ampak /foo/bar. Tako ohranimo pravilne poti povezav, ko prestavljamo spletno stran na različne domene (npr. lokalno, produkcija, testni strežnik itd.) in kadar Netlify ustvari predogledo stran.

Izobraževanja

Vsebina izobraževanj so razdeljena:

• content/izobrazevanje - izobraževanja, ki se izvajajo ob predpisanem terminu (na spletni strani so objavljena kot aktualna in pretekla)
• content/za-podjetja - izobraževanja namenjena za podjetja
• content/za-sole - izobraževanja namenjena za osnovnošolce ter dijake

Izvajalci

Direktorij content/izvajalci vsebuje strani izvajalcev. Če želite dodati izvajalca, ustvarite datoteko ter prepišite strukturo od enega izmed ostalih izvajalcev.

Obvezna polja so: title, firstName, lastName, date, bgImage ter image.

Za nalaganje svoje profile slike, sledite spodnjim navodilom.

Slike in datoteke

Če želite objavti slike ali ostale datoteke, jih lahko kopirajte v direktorij static/uploads. Končna povezavo na vir bo <DOMENA_STRANI>/uploads/<POT_DATOTEKE> (brez static!).

Kot smo že omenili, ko se sklicujemo na vir izpustimo domeno. Torej, se sklicujemo na povezavo do datoteke tako: /uploads/<POT_DATOTEKE>.

Napredno

CMS

Spletna stran uporablja Netlify CMS za grafično urejanje vsebine.

URL CMS je na: /admin.

Zaradi tehničnih omejitev (omejeno število računov ter pomanjkanje možnosti določitev pravic) ima dostop do CMS samo vzdrževalec spletne strani.

Ustvarjanje strani ("page")

1. V direktoriju content ustvarimo novo datoteko s končnico .md, ki jo poimenujemo enako kot želeno povezavo URL. Na primer: foo.md bo ustvarilo stran dostopno na /foo.

2. Odpremo datoteko, ki smo jo ustvarili v prejšnji točki in vstavimo naslednjo vsebino:

   ---
   title: Foo
   date: 2020-02-24T11:21:00.000Z
   bgImage: /uploads/page-title.jpg
   ---
   Moja vsebina v formatu markdown.

   Vsebino lahko poljubno spreminjamo (parametre: title, date, bgImage). Parameter bgImage določa sliko, ki je v ozadju glave strani. Slike so definirane v direktorju static/uploads lahko pa tudi uporabimo vsebino v direktoriju static/images. Pozor: predpone /static ne pišemo v parametru bgImage!

3. Vsebino pišemo v formatu markdown.

4. (Opcijsko) Če želimo, da se stran lahko ureja preko sistema CMS je treba povedati sistemu CMS za obstoj nove strani. To storimo tako, da v datoteki static/admin/config.yaml definiramo nastavitve strani:

   - label: "Foo"
       file: "content/foo.md"
       name: "foo"
       fields:
         - {label: "Title", name: "title", widget: string}
         - {label: "Creation Date", name: "date", widget: "datetime"}
         - {label: "Background image", name: "bgImage", widget: "image", default: "uploads/page-title.jpg"}
         - {label: "Body", name: "body", widget: "markdown"}

Dodajanje strani v glavni meni

Odpremo datoteko config.toml in dodamo nov menu.nav vnos. Kot predlogo si vzemite že definirane strani.

Ostali make ukazi

Produkcija

# Replace "http://example.com" with the base url of the site
make build-prod url=http://example.com 

Build produkcije bo nastavil ločljivost vseh .jpg slik v direktoriju static/uploads na širino 1920px (razmerje ločljivosti se bo ohranilo).

Za ta proces je potreben ImageMagick.

Ostalo

make clean  # run after "make build-dev" or "make build-prod"

Zbriše datoteke, ki jih make build-prod generira.