Tooling
Dit is de publicatie infrastructuur van Geonovum. Onder het architectuurplaatje staan:
- Een korte beschrijving.
- Verwijzing naar documentatie.
- Aandachtspunten verbeterpunten.
- Hoe we de boel beheren staat in wie beheert wat.
Kort Overzicht
[1] UML
- UML klasse diagrammen maken we met Enterprise Architect. (zie UML)
- Binnen UML gebruiken we MIM als meta-taal. (zie MIM)
- We gebruiken NEN 3610 als raamwerk.
- Overzicht
- Primitieve datatypes: Handleiding en toelichting op het toepassen van standaarddatatypes in modelleeromgeving Geonovum.
- Toolbox importeren: Handleiding voor het importeren van de MIM-toolbox in EA.
[2] Subversion
- De UML diagram worden met subversion (svn) beheerd. (zie svn)
- De repositories staan op
svn.geostandaarden.nl - Subversion installeren voor EA: Installatie SVN en informatiemodel in versiebeheer zetten.
- Subversion importeren bestaand project: Packages importeren vanuit SVN in EA.
[3] Imvertor
- Imvertor vertaalt het UML naar catalog, xsd etc. (zie Imvertor)
[4] ReSpec document
- Onze standaarden maken we in ReSpec. (zie ReSpec)
- Dit is een tool die uit een aantal bestanden (Markdown, HTML) een mooi document publiceert.
- De bestanden beheren we in GitHub
[5] GitHub
- Onze standaarden beheren en versioneren we in GitHub.
- GitHub werkwijze: algemene inleiding over GitHub.
- GitHub handleiding: Hoe maak je een account aan en hoe doe je beheertaken.
[6] docs.geostandaarden.nl
- Onze standaarden publiceren we op docs.geostandaarden.nl
- Dit gebeurt via een geautomatiseerde workflow die in onze github repositories werkt.
[7] tools.geostandaarden.nl
Op deze server staan css bestanden en hulpbestanden voor ReSpec. Ook staan hier de logo's die in docs.geostandaarden.nl gebruikt worden.
[7] beheertools
Interne server die beheertaken automatiseert.
[8] Word2ResSpec
[9] register.geostandaarden.nl
Technisch register met xml-schemas, json-schemas etc. Invulinstructies: https://github.com/Geonovum/technisch-register-2019/blob/master/documentatie/HandleidingVoorBeheerdersInformatiemodellen.md
Technische onderdelen van de standaard worden op: register.geostandaarden.nl gezet. Hoe je dit met een webhook kan doen staat beschreven in: technisch-register-2019
Invulinstructies: https://github.com/Geonovum/technisch-register-2019/blob/master/documentatie/HandleidingVoorBeheerdersInformatiemodellen.md
Technische onderdelen van de standaard worden op: register.geostandaarden.nl gezet. Hoe je dit met een webhook kan doen staat beschreven in: technisch-register-2019
UML
In de map informatiemodel wordt een informatiemodel gepubliceerd. Publicatieinstructies:
EAP
Dit is het natieve formaat van Enterprise Architect.
- Zorg ervoor dat alle links naar svn uit het bestand verwijderd zijn: selecteer een beheerde folder. Kies 'Configure->Package-VC'. Haal het vinkje weg bij 'Control Package'.
- Zet de versienummer van het model in de bestandsnaam.
xmi
xmi is het uitwisselformaat voor UML modellen. Er zijn veel smaken. Voorstel voor manier van publiceren:
- Niet alleen het model, maar ook alle packages waarnaar verwezen wordt.
- Selecteer het te exporteren root package. Kies 'Publish-->Export XML'.
- Kies Export Type: 'XML 1.1'.
[10] Markdown
- Markdown handleiding: Handleiding werken met Markdown voor ReSpec-documentatie.
[11] Ontologie (modellen.geostandaarden.nl)
- Ontologie: Handleiding voor het maken en publiceren van een ontologie.
[13] Nationaal Georegister
Staat los van de rest van de publicatie infrastructuur.
[14] Web server van Geonovum
Staat los van rest van publicatie infrastructuur.
[17] Modeldesk UML tooling
beheer
Voor licenties of de interne beheerder van de tooling kun je terecht op intranet
MkDocs voor deze handleiding
Deze handleiding maakt gebruik van MkDocs, een lichtgewicht tool die een doorzoekbare en navigeerbare site maakt van een verzameling Markdown documenten. De handleiding staat op github pages. De bronbestanden staan in: handleiding-tooling.
Je kunt mkdocs ook lokaal installeren. Dan kun je live je edits volgen in je browser: http://127.0.0.1:8000/ met het commando:
mkdocs serve