Updated readme

fdnd · Sep 14, 2023 · c1acb1f · c1acb1f
1 parent 759ee9b
commit c1acb1f
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ een opleiding van de Hogeschool van Amsterdam op niveau 5.
 
 ## Bijdragen
 
-Al onze niet AVG gevoelige informatie is publiek toegankelijk. Als je het ergens niet mee eens bent, als je foutjes ontdekt of als je een bijdrage hebt dan staat het je vrij aanpassingen te maken en een _pull-request_ in te schieten. Je kunt natuurlijk ook gewoon een _issue_ schrijven, kies daarbij alstjeblieft het juiste
+Al onze niet AVG gevoelige informatie is publiek toegankelijk. Als je het ergens niet mee eens bent, als je foutjes ontdekt of als je een bijdrage hebt dan staat het je vrij aanpassingen te maken en een _pull-request_ in te schieten. Je kunt natuurlijk ook gewoon een _issue_ schrijven, kies daarbij alsjeblieft het juiste
 _issue template_.
 
 ## Installatie
@@ -20,13 +20,13 @@ Als je wilt bijdragen is het handig als je dat op jouw lokale machine kunt doen.
 2. _Clone_ jouw _forked_ _repository_ naar je lokale omgeving
 3. Voer `npm install` uit
 4. Maak de aanpassingen die je wilt maken. In de `docs` map staan de documenten in _markdown_ formaat en in de `src` map staan de bestanden die gebruikt worden voor het `parsen` van de documenten.
-5. Voer `npm start` uit om de documenten in de `docs` map te _parsen_ en te verplaatsen naar de `build` map.
+5. Voer `npm run dev` uit om een ontwikkelomgeving te starten. Wijzigingen in de `src` én in de `docs` map _triggeren_ een rebuild welke automatisch herladen wordt in de browser.
 
 ## Documentatie
 
 ### Ondersteunde Markdown syntax
 
-[Docs.fdnd.nl](https://docs.fdnd.nl) gebruikt [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/) om Markdown bestanden te parsen. Dit betekend dat een aantal extenties ondersteund worden, bovenop de standaard Markdown specificatie. Daarbovenop wordt [Shiki](https://shiki.matsu.io/) gebruikt om codevoorbeelden te highlighten. Hieronder enkele highlights van de syntax die je kunt gebruiken.
+[Docs.fdnd.nl](https://docs.fdnd.nl) gebruikt [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/) om Markdown bestanden te parsen. Hierdoor worden een aantal extenties ondersteund bovenop de standaard Markdown specificatie. Daarnaast wordt ook [Shiki](https://shiki.matsu.io/) gebruikt om codevoorbeelden te highlighten. Hieronder enkele highlights van de syntax die je in [Docs.fdnd.nl](https://docs.fdnd.nl) kunt gebruiken.
 
 #### Tabellen
 
@@ -102,8 +102,26 @@ wordt geparsed naar
 
 #### Autolinks
 
+Je kunt links en emailadressen tussen < en > plaatsen en die worden automatisch geparsed naar html-anchor elementen met de URL of het email adres als inhoud. Een autolink bestaat uit een < gevolgd door een absolute URL gevolgd door >. Een absolute URL bestaat uit een schema gevolgd door : gevolgd door nul of meer ASCII karakters met uitzondering van witruimte en >. Een email autolink bestaat uit een < gevolgd door een email adres gevolgd door een >.
+
+##### Voorbeeld
+
+De volgende regel in markdown
+
+```md
+Je kunt <http://fdnd.nl> bereiken via <[email protected]>.
+```
+
+wordt geparsed naar:
+
+```html
+<p>Je kunt <a href="http://fdnd.nl">http://fdnd.nl</a> bereiken via <a href="mailto:[email protected]">[email protected]</a></p>
+```
+
 #### Code highlighting (Shiki)
 
+Shiki wordt gebruikt met het _monokai_ kleurenschema. Als je code in je tekst opneemt, begin dan met drie backticks (`) gevolgd door de afkorting van de taal die je gebruikt: html, css, js, json, svelte ([en vele andere](https://github.com/shikijs/shiki/blob/main/docs/languages.md)). Jouw code wordt dan door Shiki vertaald naar html-code met inline color-coding volgens _monokai_.
+
 ## Referenties
 
 Docs.fdnd.nl maakt gebruik van de volgende _npm-packages_:
@@ -113,4 +131,4 @@ Docs.fdnd.nl maakt gebruik van de volgende _npm-packages_:
 
 ## License
 
-MIT
+GPL-3.0 license
diff --git a/docs/organisatie.md b/docs/organisatie.md
@@ -10,15 +10,15 @@ Om dicht bij het beroepenveld te blijven wordt de organisatie van de Ad Frontend
 
 Tribes zijn de grootste organisatie-eenheid en kunnen vergeleken worden met een cluster bij andere opleidingen. Een tribe bestaat uit maximaal 100 personen, bestaande uit docenten én studenten. Één docent is tribe leader (0,2 fte) en is verantwoordelijk voor de coördinatie, roostering en evaluatie van onderwijsactiviteiten van de tribe. De tribe leader is de 1e contactpersoon voor docenten binnen de tribe, er is binnen tribes een regelmatige overlegstructuur en docenten weten van elkaar wat er speelt. Een tribe bestaat uit maximaal vier squads.
 
-Squads zijn een kleinere organisatie-eenheid binnen een tribe en kunnen vergeleken worden met een klas bij andere opleidingen. Een squad bestaat uit maximaal 25 personen, docenten én studenten. Één docent is squad-leader (0,45 fte) en eindverantwoordelijk voor het dagelijks onderwijs van een squad. De squad-leader kent alle studenten in de squad en begeleid deze bij het volbrengen van leertaken. De squad-leader verzorgt workshops, talks en overlegt en stemt af met co-teachers en gastsprekers. Ook neemt de squad-leader deel aan overleg binnen de tribe.
+Squads zijn een kleinere organisatie-eenheid binnen een tribe en kunnen vergeleken worden met een klas bij andere opleidingen. Een squad bestaat uit maximaal 25 personen, docenten én studenten. Één docent is squad-leader (0,45 fte) en eindverantwoordelijk voor het dagelijks onderwijs van een squad. De squad-leader kent alle studenten in de squad en begeleidt deze bij het volbrengen van leertaken. De squad-leader verzorgt workshops, talks en overlegt en stemt af met co-teachers en gastsprekers. Ook neemt de squad-leader deel aan overleg binnen de tribe.
 
 Chapters zijn groepen docenten en professionals met een bepaald expertise (bijvoorbeeld API nerds/ node.js/ design languages etc.) die met regelmaat bijeen komen om ervaring te delen en ontwikkeling bij te houden.
 
 Guilds zijn groepen docenten én studenten met een gedeeld kenmerk, bijvoorbeeld een guild voor studenten die extra aandacht nodig hebben, een guild voor engels, een guild voor hoogvliegers, een guild die het opleidingsmodel itereert, een guild die leertaken bijwerkt, een toetscommissie, opleidingscommissie et cetera.
 
 ## Rollen
 
-### Co-teacher (0,2 - 0,4 fte)
+### Co-teacher (0,1 - 0,4 fte)
 
 De Ad FDND vraagt van docenten dat zij naast inhoudsdeskundige en beoordelaar ook begeleider zijn die samen met de student het leerproces van de student stimuleert en vormgeeft.
 
@@ -29,7 +29,7 @@ Een co-teacher:
 - Verzorgt af en toe een talk of een workshop in afstemming met squad-leader(s);
 - Overlegt en stemt af met de squad-leader;
 - Neemt deel aan Standup, Plan & Review en Retrospective meetings.
-- (In het geval van assesorschap) Heeft assessorcertificering of is bereid deze te behalen;
+- (In het geval van assesorschap) Heeft deelgenomen aan de assessorentraining of is bereid deze te volgen;
 
 ### Squad-leader (0,5 fte)
 
@@ -39,7 +39,7 @@ Een squad-leader:
 
 - Heeft een van de of een combinatie van de expertises Frontend-developer, Interaction Designer of Digital Designer;
 - Heeft de basiskwalificatie didactische bekwaamheid (BDB) en de basiskwalificatie examinator (BKE) of is bezig deze te behalen;
-- Heeft assessorcertificering of is bezig deze te behalen;
+- Heeft deelgenomen aan de assessorentraining of is bereid deze te volgen;
 - Is eindverantwoordelijk voor het leerproces binnen de squad;
 - Kent de studenten in de squad en begeleid bij het volbrengen van deel- en leertaken;
 - Is op de hoogte van en draagt bij aan de invulling van het onderwijsprogramma;