Tema
Prvo je bitno predložiti temu i dobiti potvrdu članstva da je takav članak poželjan. Najbolje je to učiniti u ovoj kategoriji foruma, s dodanom podkategorijom "UBIK blog prijedlog" i naslovom koji odgovara kontekstu, npr: "Detaljni opis funkcioniranja DyDx platforme".
Ukoliko članovi pozitivno reagiraju na prijedlog, kreće se na skicu.
Napisati draft (skicu)
Izvorni materijal na ubik.hr blogu je u MarkDown formatu. MarkDown je tekstualni format koji je i ljudima i strojevima lako čitljiv, te ga je izrazito jednostavno naučiti. MarkDown format je obavezan. Članci pisani u Google Docs, Word, PDF i drugim formatima biti će automatski odbijeni.
Za pisanje skice preporučamo alate poput Hackmd.io koji omogućuju istovremeni pregled izgleda članka u desnoj polovici sučelja, što vam dopušta da s sigurnošću pišete sadržaj koji uključuje linkove, slike, kod, citate, i ostalo.
Napomena: Ukoliko želite ubaciti link na neki vaš proizvod, tvrtku, Twitter račun ili drugo, ostavite to za mini-bio u podnožju samog članka. Mini-bio može biti kratak opis autora, uključujući linkove koje autor želi promovirati. Za primjer, vidi ovdje.
Slike
Ukoliko vaš post sadrži neke slike (preporuča se text-break jednom relevantnom slikom svakih 500 riječi), možete ih testirati tako da ih hostate na imgur.com za vrijeme pisanja skice. Kad je skica gotova, sve slike odvojite u posebnu datoteku, trebati će vam.
Svaki post mora imati glavnu sliku koja se prikazuje pri vrhu članka i kao sličica u popisu postova, no ukoliko vam ne pada na pamet neka dobra slika i/ili ne možete legalno doći do neke stock fotografije ili grafike, mi ćemo istu dodati za vas.
Frontmatter
Svaki članak mora imati frontmatter - podatke na samom početku teksta koji se ne prikazuju već se koriste za pravilni prikaz samog članka (kategorije, datum, autor, itd.). Frontmatter podaci se ispisuju na sljedeći način:
---
title: "Naslov"
date: 2020-10-07
draft: false
image: "images/blog/placeholder.png"
author: "Bruno Škvorc"
tags: ["Blockchain", "Event"]
type: "post"
---
Tekst skice ide ovdje...
Vrijednosti su sljedeće:
title: Naslov članka, mora biti u navodnicima.date: datum publikacije, postaviti datum u dogovoru s UBIKom, ponekad je potrebno tempirati publikacijae zbog lakšeg konzumiranja sadržaja. Format je YYYY-MM-DD.draft: ostaviti na false.image: lokacija glavne slike članka. Uvijek počinje s "images/blog" a završava s slikom koju ste namijenili za glavnu sliku članka. Ako nemate ideju, ostavite na "images/blog/placeholder.png"author: ime autora, u navodnicima.tags: popis kategorija u koje ovaj članak pripada. Moguće kategorije su izlistane na stranici https://ubik.hr/blog/ pod Tagovi. Ako smatrate da je potreban novi tag, dodajte ga. O odboru ovisi hoće li biti prihvaćen.type: ostaviti na "post"
Upload članka
Članci se dodaju kroz pull request na Githubu. Drugim riječima, šaljete softverski zahtjev našem repozitoriju da doda novi članak. Administratori tog repozitorija pregledavaju vaš zahtjev, predlažu ispravke ukoliko su potrebne, i eventualno ga prihvaćaju, nakon čega se članak automatski pojavljuje na blogu. Postoje dva pristupa za kreiranje zahtjeva: CLI (command line) ili Github UI (sučelje).
U oba slučaja potrebno je imati Github račun i forkati repozitorij UBIKove stranice:
Nakon toga, imati ćete kopiju UBIKove web stranice pod web adresom https://github.com/MOJE_KORISNICKO_IME/web.
CLI (preporučeno)
Za ovaj proces potrebno je imati instaliran Git na vašem računalu. Pratite sljedeće korake:
U terminalu (komandni prozor - Terminal aplikacija na Mac OS \ Linux sustavu ili Git Bash na Windows) klonirajte repozitorij vašeg forka:
git clone https://github.com/MOJE_KORISNICKO_IME/web ubikweb
Uđite u kreiranu mapu ubikweb sa naredbom cd ubikweb i napravite novi branch: git checkout -b moj-novi-clanak (ime brancha je ovdje "moj-novi-clanak no vi je nazovite kako želite - koristite isključivo engleska slova i bez razmaka").
U poddirektorij site/content/english/blog kreirajte .md datoteku za vaš članak. Nazovite je prema naslovu. Preporučamo URL-ifikaciju naslova ovim alatom pa će tako "Ovo je neki članak" postati ovo-je-neki-clanak.md.
U poddirektorij site/static/images/blog stavite slike vašeg članka, brinući pritom da njihove reference u tekstu odgovaraju tom formatu (npr. ako ste koristili imgur za testiranje slika tokom pisanja skice, ne zaboravite promijeniti adrese slika).
Spremite promjene u repozitorij naredbom git add -A && git commit -am "Dodan clanak XYZ". XYZ slobodno zamijenite naslovom članka.
Pošaljite promjene na Github naredbom git push origin moj-novi-clanak (zamijenite moj-novi-clanak imenom brancha koje ste odabrali u prvom koraku).
Posjetite Github sučelje vašeg forka na https://github.com/MOJE_KORISNICKO_IME/web, kliknite ponuđeni gumb "Create pull request" da napravite zahtjev za dodavanjem članka.
Ukoliko administratori repozitorija zahtijevaju neke promjene, iste će možda biti rješive u samom sučelju (većina slučajeva), a one koje nisu rješive u pregledniku rješavaju se tako da promjene izvršite na md datoteci koju ste dodali u 2. koraku i ponovite korak 5. i 6. 7. neće biti potreban - vaš zahtjev će se automatski ažurirati.
Github UI
- Na vašem računalu napravite mapu koja će sadržavati sav sadržaj vašeg članka - tekst i slike. Tekst vaše skice stavite u datoteku
moj-naslov.md. Nazovite je prema naslovu. Preporučamo URL-ifikaciju naslova ovim alatom pa će tako "Ovo je neki članak" postati ovo-je-neki-clanak.md. To će izgledati otprilike ovako:
Promijenite adrese svih slika u tekstu tako da odgovaraju sljedećem formatu: /images/blog/SLIKA. U primjeru gore, to bi bilo /images/blog/dummies.png, /images/blog/spike.png, i /images/blog/alkemija.png na odgovarajućim mjestima u članku.
Otvorite Github sučelje vašeg forka na https://github.com/MOJE_KORISNICKO_IME/web ili URLu koji ste sami odabrali prilikom forkanja. Napravite novi branch od master brancha:
Navigirajte u site/content/english/blog, pa na Add File, pa na Upload files, te dodajte članak u tu mapu odabirom istog s vašeg računala:
Ako vaš članak ima slike, učinite to isto, samo u mapu site/static/images/blog:
Pošaljite zahtjev za dodavanjem vašeg članka (pull request - PR) iz vašeg brancha u vašem forku u master branch UBIK web repozitorija (vidi gif ispod za detalje - opcije su automatski podešene). Dobro je dodati opis u PR radi konteksta.
Ono što se u ovom koraku zapravo događa je da se promjene na vašem novo kreiranom branchu (iz koraka 3) pakiraju u jedan set izmjena koji se tada predlaže glavnom repozitoriju. Ukoliko u budućnosti trebate dodati novi članak, ponovite sve korake i pazite da radite novi branch od master brancha, a ne od brancha nekog prijašnjeg članka koji ste kreirali (promjena brancha nazad na master vrši se klikom na branch izbornik iz koraka 3).
Moguće je da će administratori zahtijevati neke promjene od vas. U tom slučaju vratite se na vaš fork u branch vašeg članka te učinite promjene. Npr. ako treba nešto izmijeniti na članku, izmijenite to na vašem računalu i napravite ponovni upload članka. Promjene će se automatski reflektirati na vašem zahtjevu za dodavanje (PR-u), nema potrebe za ponavljanjem koraka 6.
Nakon provjere od strane administratora i možda kojih potrebnih promjena, vaš će se članak pojaviti na UBIK blogu.
