Portfolio opzetten (1h)

Dit is de GitHub repository voor het thermodynamica deel van IP2. De bedoeling is dat je deze repository kloont en je vervolgens samen met je labpartner zelf een ‘website / portfolio’ bouwt op basis van jullie werk.

Per duo volgt een de onderstaande stappen waarna de anderen uitgenodigd worden om bij te dragen aan deze repository.

Klonen en opzetten van je eigen repository¶

Volg onderstaande instructie om je eigen repository op te stellen.

Ga naar de repository
Klik op de groene knop code en kopier de url.
Open VSC en open een terminal (via ctrl + ~ of via view $\rightarrow$ terminal).

Gebruik van de terminal

Je bent waarschijnlijk gewend om met een grafische interface (en je muis) te werken: Je klikt naar de locatie waar je heen wilt. In de terminal werk je met commando’s. Navigeren door de terminal doe je met cd <folder> (waarbij <folder> de folder is waar je naartoe wilt gaan).

Met cd .. ga je een folder omhoog.
Met ls of dir zie je de inhoud van de folder waar je in zit.
Wil je naar een andere drive, dan typ je de drive letter gevolgd door een dubbele punt (bijv. D:).
Met mkdir <folder> maak je een nieuwe folder aan (waarbij <folder> de naam is van de nieuwe folder).
Met rmdir <folder> verwijder je een lege folder (waarbij <folder> de naam is van de folder die je wilt verwijderen).
Met rm <file> verwijder je een bestand (waarbij <file> de naam is van het bestand dat je wilt verwijderen).
Met code . open je de huidige folder in VSC.

Navigeer in de terminal naar de locatie waar je je repository wilt opslaan (bijvoorbeeld cd Documents/studie/jaar 1/IP2/). Maak een nieuwe folder aan met mkdir Project en ga naar deze folder met cd Project.
Typ in de terminal git clone <url> (waarbij <url> de url is die je gekopieerd hebt (waarschijnlijk https://github.com/Contemporary-Physicslab/thermolab.git)) en druk op enter.

Nu worden alle bestanden van de repository gedownload naar je computer, maar deze zijn nog steeds gelinkt aan de originele repository (dus als je nu iets pusht, komt het in de originele repository terecht - dat mag echter niet want je hebt geen schrijfrechten). We moeten dus de link met de originele repository verbreken en een nieuwe repository aanmaken.

Gebruik nu cd thermolab om in de thermolab folder te komen.
Als dat gelukt is typ git remote remove origin (om de link met de originele repository te verbreken).

Je kunt zowel via de terminal een nieuwe repository aanmaken als via de website van GitHub. Hieronder staat de methode via de website van GitHub beschreven. Ga naar GitHub en doorloop onderstaande stap.

Maak een nieuwe repository aan op GitHub (via de + rechtsboven in je scherm en dan new repository).
Kies jullie groepsnummer als naam voor je repository (dit zal ook deel uitmaken van je URL!), verifieer dan dat Choose visibility * op public staat. Klik daarna op de groene knop Create repositorty.
Ga in je repository naar settings en in het linkermenu naar Pages en kies onder het kopje Source de optie Github actions.
Klik op code (linksboven).
Kopier de url van je nieuwe repository (deze heb je zo dadelijk nodig).

We hebben nu een nieuwe repository aangemaakt, maar deze is nog leeg. We moeten nu de bestanden die we gedownload hebben naar deze nieuwe repository pushen.

Ga terug naar VSC.
Typ in de terminal git remote add origin <url> (waarbij <url> de url is van je nieuwe repository).

Nu zijn de bestanden op je computer gelinkt aan je nieuwe repository, maar staan ze nog niet in je nieuwe repository. We moeten ze nu pushen.

Typ in de terminal git push -u origin main (om de wijzigingen naar je nieuwe repository te pushen).

Als je nu naar je nieuwe repository op GitHub gaat en de pagina ververst (via F5 of via de reload knop in je browser), zie je dat alle bestanden zijn geupload.

Klik op het gear-icon (naast About) aan de rechterkant van de pagina.
Vink het vakje Use your GitHub Pages website aan.

Je kunt nu ook de output zien op je eigen GitHub website! Klik daarvoor de link die rechts staat onder code $\rightarrow$ onder About.

Je partner(s) uitnodigen¶

Bij IP2 werk je in tweetallen of drietallen. Je kunt je partner(s) uitnodigen om mee te werken aan jouw repository. Ga daarvoor naar je nieuwe repository op GitHub en doorloop onderstaande stappen.

Ga naar je nieuwe repository op GitHub.
Klik op settings (rechtsboven in je scherm).
Klik in het linkermenu op Collaborators.
Klik op de knop Add people onder het kopje manage access.
Typ de gebruikersnaam van je partner(s) en klik op add <username> to this repository (waarbij <username> de gebruikersnaam is van je partner).

Als partner krijg je een mailtje met een uitnodiging om mee te werken aan de repository. Als je deze accepteert, kun je allebei wijzigingen aanbrengen in de repository.

Partner accepteert uitnodiging¶

Je partner krijgt een mailtje met een uitnodiging om mee te werken aan de repository. Als je deze accepteert, kun je allebei wijzigingen aanbrengen in de repository.

Volg stappen 1 tot en met 6, maar dan op basis van de url van de repository waarop je bent uitgenodigd. Ga NIET verder met stap 7 want de koppeling met de bestaande repository wil je behouden.

Je eerste wijzigingen doorvoeren¶

Je hebt nu een eigen repository met alle bestanden die nodig zijn om een website te bouwen. Je kunt nu zelf aan de slag om de inhoud van de website aan te passen. Belangrijkste is om eerst even de URL aan te passen in het hoofdbestand.

Open de myst.yml file in VSC. Daar zie je op twee plekken een URL naar github. Pas deze URL aan naar de URL van je eigen repository.
Je kunt nu de repository bijwerken via de terminal, een andere optie is links in VSC te kliken op het source control icoon (het derde icoon van boven, dat eruit ziet als een vork met drie punten). Daar geef je een samenvatting van je wijzigingen en klik je op het vinkje (bovenaan) om de wijzigingen toe te voegen. Daarna klik je op de drie puntjes (bovenaan) en kies je push om de wijzigingen naar je repository te pushen.