README.md

bawang-content

Innehåll på https://datasektionen.se

Hur fungerar vår hemsida? 🤔

Vår hemsida består av tre delar: bawang, taitan och bawang-content.

bawang-content

Detta repo. Här skrivs allt innehåll i Markdown.

taitan

Taitan parsar Markdown (allt innehåll i detta repo) och gör om det till JSON och HTML. Besök https://taitan.datasektionen.se för att se ett exempel. Vill man se hur taitan parsar andra sidor kan man exempelvis besöka https://taitan.datasektionen.se/organisation.

bawang

Bawang är vår React-frontend som hämtar data från taitan och lägger in det i sina komponenter. Bawang hämtar alltså JSON med HTML och annan information och laddar in som innehåll.

Varför?

På detta sätt kan innehållsändringar göras av vem som helst som har tillgång till detta repo. Ändringarna behöver inte deployas för att komma upp på hemsidan, taitan hämtar allt direkt från detta repo. Vill man däremot göra förändringar i React-frontenden måste sådant såklart deployas (men det görs ju också automatiskt nu för tiden så...).

Redigera innehåll ✍️

Klona repot och gör en ny branch som du kan jobba på. När du är färdig gör du en PR (pull request). Gäller ändringarna någon annan nämnds/projekts/funktionärs sida kan det vara bra att tagga dem så att de godkänner förändringarna.

Vi har stängt av commits direkt till master.

Om du inte har access att pusha till repot kan du säkerligen få det om du frågar Systemansvarig. Annars går det även att göra en egen fork, men det gör saker i allmänhet lite krångligare.

Köra lokalt

Repot har en compose.yml-fil som sköter all setup med bawang och taitan. Så om du vill redigera hemsidan lokalt och vill se dina ändringar innan du pushar så är det bara att installera docker och sedan köra

docker compose up

Därefter så kommer sidan vara tillgänglig på localhost:8000. Om du ändrar på en sida så är det bara att ladda om webbläsaren för att se dina ändringar.

Utveckla taitan eller bawang lokalt

I filen compose.yml så går det att ersätta vissa delar för att istället köra med lokala versioner av taitan och bawang.

Följ instruktionerna i composefilen, och kör sedan kommandot

docker compose up --build --watch

Hemsidan kommer då vara tillgänglig på localhost:8000. När något ändras i din lokala version av taitan eller bawang så kommer serven för den byggas och startas om automatiskt.

Innehåll som är känsligt under mottagningen 🕶️

Om någon del av en sida inte ska visas under mottagningen kan detta automatiskt döljas under mörkläggningen genom att sätta {{ if not .reception -}} innan och {{- end }} efter. Till exempel:

{{ if not .reception -}}
    Något mycket mycket hemligt!
{{- end }}

Om texten istället för att gömmas helt ska bytas ut mot något annat kan man använda en if else-sats, till exempel:

Konglig Datasektionen har {{ if .reception -}} aldrig haft någon mottagning. {{- else -}} sedan 1983 haft en mottagning varje år! {{- end }}

Mer specifikt används det inbyggda templating-systemet i Go, som man kan läsa mer om här.

Om någon sida ska döljas helt under mörkläggningen kan man istället sätta Sensitive = true i sidans meta.toml.

Översätt hemsidan 🇬🇧🇺🇸

Egentligen borde hela webbsidan vara tillgänglig på engelska, men vi har ett problem i att vi inte översatt stora delar av den än. Du får gärna översätta den engelska sidan, som finns under mappen /en.

En engelskspråkig webbsida är jätteviktig för att utbytesstudenter ska kunna ta del av innehållet. Tänk på att det är de som är målgruppen när du översätter. Kom också ihåg att alla detaljer inte måste komma med i översättningen, bara du får med det viktigaste så är redan det väldigt värdefullt!