Denne dokumentasjonen inndeholder 2 deler:
- Norsk beskrivelse av git-prosedyrer som commits, branches, issues etc. som må følges for å holde repositoriet organisert.
- En engelsk generalisert quickstart guide for hvordan man faktisk kan begynne å endre på wikien.
Til den grad hensiktsmessig skal alt foregå på norsk. Dette er for å forbedre leseligheten av repositoriet for brukere som ønsker å utforske diverse endringer. Det er svært verdifullt å skille mellom når vedtekter, retningslinjer og diverse inforamsjon endres på wikien. Ikke-tekniske brukere vil også slite med å forstå endringen om de må begynne å tolke engelske beskrivelser opp mot norsk brødtekst.
Brancher kan være 1 av 4 kategorier og må være etterfulgt med en beskrivelse av hva branchen endrer eller legger til:
kode/
Alt som omhandler å primært endre noe av programmatisk betydning(eks. styling, komponenter, logikk, biblioteker etc.). I kode-brancher bør man minimere endringer av den faktiske brødteksten i wikien.
git branch kode/informasjonskort-for-undergrupper
diverse/
Endring av all tekst og informasjon i wikien som ikke direkte omhandler vedtekter eller retningslinjer. Slike brancher kan også inkludere endring av sidestruktur og tillegg av mindre tekniske implementeringer som bilder og iframes. Endringene i slike brancher kan utføres vilkårlig av HS medlemmer.
git branch diverse/sanger-lambo
retningslinjer/
Endring av all tekst og informasjon som direkte relaterer til "Retningslinjer" siden på wikien. Endringer i slike brancher må ha blitt vedtatt av HS og branchen må ha en underkategori som inndeholder saksnummer og årstall i formatet HsSaksnr-yy. Ble en retningslinje vedtatt endret utenfor et HS møte eller som en eventuellsak, viser man dette med symbolet 'symbolet 'd' og datoen for vedtaket i formatet 'd'-dd-mm-yy.
git branch retningslinjer/6-24/betalende-arrangementer
git branch retningslinjer/d-02-03-24/grafiske-retningslinjer
vedtekter/
Endring av all tekst og informasjon som direkte relaterer til "Vedtekter" siden på wikien. Endringer i slike brancher må ha blitt vedtatt av Generalforsamlingen eller være en redaksjonell endring vedtatt av HS. Ved saksbaserte endringer av generalforsamlingen skal formatet være følgende generalforsamling/GenforsSaksnr-yy. Ved redaksjonelle endringer skal det samme formatet som utnyttes ved retningslinjer brukes: redaksjonell/HsSaksnr-yy eller redaksjonell/'d'-dd-mm-yy.
git branch vedtekter/generalforsamling/8-24/inaktive-medlemmer
git branch vedtekter/redaksjonell/18-24/oppdatering-av-studienavn
git branch vedtekter/redaksjonell/d-05-09-24/rettelse-skrivefeil
Alle commits må ikke være på norsk(typ autogenererte versjonsoppdateringer og merge requests), men alt annet som kan være av verdi for "ikke-tekniske" TIHLDE medlemmer bør beskrives med fornuftig norsk. For mindre endringer kan beskrvelsen være enkel og objektiv, men for retningslinjer og vedtekter kan det være lønnsomt med en kort oppsummering om hvorfor endringen ble gjennomført.
git commit -m "La til wiki-side for økonomiske søknader"
git commit -m "Gruppeoversiktene henter nå automatisk gruppebeskrivelse fra TIHLDEs nettside"
git commit -m "Vedtatt at stjeling fra kiosken er nå straffbart"
Issues trenger ikke noe spesifikt format, men de må ha en konsis tittel ettersom dette vil bli et branchnavn.
TIHLDE WIKI is a site built upon a Tailwind UI site template built using Tailwind CSS and Next.js.
To get started with this template, first install the npm dependencies:
npm installNext, run the development server:
npm run devFinally, open http://localhost:3000 in your browser to view the website.
All the text from the site is written in markdown files. This is a simple way to write text and it is easy to learn. This is the same way that the old wiki was written (also events and news on the main TIHLDE site).
The project is structured with folders which represents the url path of the site. You set the url path by creating a folder with your desired name in the following directory:
src/app/<your-folder>
# Example
src/app/kontakt -> http://localhost:3000/kontaktEach folder contains one and only one page.mdx file. This file is the main content of the page. The content of this file will be displayed on the page. This is a markdown file, so you can write markdown in this file. The 'x' in mdx stands for TSX, which means that you can write TSX in this file as well. For normal use cases, you will only need to write markdown, but if you want some more fancy components you can import React components (TSX).
To create a new page, create a new folder in the src/app directory. Inside this folder, create a page.mdx file as explained above. This file will contain the content of the page.
At last we must add the new page to the navigation. This is done in the src/components/Navigation.tsx file. Here you can add a new object to the navigation array at the end of the page. The object should contain the following properties:
{
title: 'Kontakt oss',
href: '/kontakt',
// This is optional if you want to add a dropdown menu
links: []
}Each page.mdx file contains a metadata object at the top of the file. This object contains information about the page, such as the title and description. This information is used to generate the page's metadata, such as the title tag and meta description tag. Metadata is used to improve SEO and accessibility.
export const metadata = {
title: 'Kontakt oss',
description:
'Har du spørsmål eller trenger hjelp? Kontakt oss her.'
};To make changes to the site, you must first create a pull request. When the pull request is approved, the changes will be deployed to the live site.
# Create a new branch
git checkout -b <branch-name>
# Make your changes
# Add and commit your changes
git add .
git commit -m "Your commit message"
# Push your changes to GitHub
# After the first time, you can use `git push` without the origin and branch name
git push origin <branch-name>
# Create a pull request on GitHub
# After the pull request is approved, you can merge the changes into the main branch, which will deploy the changes to the live siteIf you find something wrong with the site, or if you want to improve the site, you can create an issue on GitHub. You can also create a pull request with your changes, and this will be approved if the changes are good.
To learn more about the technologies used in this site template, see the following resources:
- Markdown - a guide to Markdown
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- Headless UI - the official Headless UI documentation
- Framer Motion - the official Framer Motion documentation
- MDX - the official MDX documentation
- Algolia Autocomplete - the official Algolia Autocomplete documentation
- FlexSearch - the official FlexSearch documentation
- Zustand - the official Zustand documentation