Nieuw projekt - MinBZK/odl GitHub Wiki

Maak een nieuw Gitlab project aan en kloon dit project in vscode. Maak daarin een config directory met minstens de volgende directories:

config

Deze bevat configuratiefiles. De volgende files moeten aanwezig zijn:

.env

Deze file bevat je username en wachtwoord voor postgres als volgt:

POSTGRES_USER=<user name>
POSTGRES_PASSWORD=<password>

bootstrap-config.yaml

Een file die een verwijzing bevat welke config file moet worden gebruikt. Een projekt kan verscheidene config.yaml files bevatten, bijvoorbeeld een voor test en een voor produktie. Het command START_FROM in bootstrap.yaml bepaalt welke config file wordt gebruikt. Gebruiki een absoluut pad.

START_FROM: /data/arnoldreinders/projects/huisvesting/bezettingsgraad/config/config-d3g-test.yaml

bootstrap-program.yaml

Een file voor de ontwikkelaar waarmee bepaalde programma aspekten kunnen worden ingesteld. Momenteel is dit alleen postgres-types: een lijst met postgres types die zijn toegestaan in d3g.

<<>>

docs

Een directory met subdirectories per leverancier. Elk leveranciersdirectory kan dokumentatie die wordt gebruikt bij de generatie van de definitieve dokumentatie over de data.

Er zijn twee files: filenaam.prefix.md en filenaam.suffix.md. Bij het genereren van de markdowndokumentatie over een tabel wordt de prefix informatie ingevoegd voor de tabelbeschrijving en de suffix informatie na de tabelbeschrijving.

schemas

Een directory met subdirectories per leverancier, zie ook projectstruktuur. Per leverancier moeten twee .csv files worden aangemaakt:

[filenaam.schema.csv](Schema file): bevat schema informatie over de attributen
[filenaam.meta.csv](Meta file): bevat meta informatie over de levering