Skip to content

Commit

Permalink
architectuurplaatje aangepast.
Browse files Browse the repository at this point in the history
  • Loading branch information
wilkoquak committed Mar 4, 2024
1 parent a76493b commit 9914d72
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 15 deletions.
37 changes: 29 additions & 8 deletions docs/Markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Het ontwerpdoel van de taal is leesbaarheid. Teksten geschreven met behulp van
Markdown worden geacht al leesbaar te zijn voordat opmaak is toegepast op de
tekst. Opmaakinstructies en tags zijn dan ook niet te vinden in pure Markdown.

## Het viewen van Markdown in je broswer
## Lokale markdown in je browser

Sommige browsers weigeren het openen van lokale bestanden, of negeren links naar
locale bestanden. Dit kun je in de configuratie aanpassen:
Expand All @@ -35,9 +35,9 @@ Dit kan je ook in een snelkoppeling zetten als icoon op de desktop.

In Firefox kan je dat instellen via de parameters.

In de adresbalk: about:config, dan het risico aanvaarden, en deze parameter
veranderen: `security.fileuri.strict_origin_policy = false` (dus op false
zetten)
- Kies: <about:config>
- Vertel firefox dat je weet waar je mee bezig bent.
- `security.fileuri.strict_origin_policy = false` (dus op false zetten)

## Tools voor Markdown

Expand All @@ -50,12 +50,21 @@ zetten)
| [Tables Generator](https://www.tablesgenerator.com/markdown_tables) | Helpt met het maken van tabellen in MarkDown |
| [Markdown Table](https://marketplace.visualstudio.com/items?itemName=TakumiI.markdowntable) | VSCode plugin voor het editen van Markdown tabellen. |
| [Prettier](https://prettier.io/) | Een code formatter die automatisch zorgt dat je markdown aan de regels voldoet. |
| [mdlint](https://github.com/Laboratoria/mdlint) | Een style checker form markdown bestanden. Geef meldingen voor verkeerde markdown |
| [markdownlint](https://github.com/Laboratoria/mdlint) | Een style checker form markdown bestanden. Geeft meldingen voor verkeerde markdown |
| [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) | VSCode plugin. Klik rechtsonder op "Go Live" en je ReSpec doc wordt in live browser geopend. |

> **Note** `@Wilko`: we kunnen nog styling regels voor markdown vastleggen.
> Maximale regellengte = 80 bijvoorbeeld. Dit kan door een `.prettierrc` in de root van
> een project te zetten.
## Regels voor Markdown

Styling regels vastleggen voor Markdown zorgt ervoor dat wijzigingen in de markdown ook
altijd inhoudelijke wijzigingen zijn. Suggesties hiervoor

- Regellengte vastleggen.
- Hoeveel springen we in?
- Gebruiken unix end-of-line of windows

Deze afspraken kunnen we ook vastleggen. Zie hieronder twee voorbeelden. Het lijkt
erop dat de veschillende tools op verschillende manier formatteren. Niet alles
gaat goed samen.

Voorbeeld van '.prettierrc' gebruikt in dit project:

Expand All @@ -69,3 +78,15 @@ Voorbeeld van '.prettierrc' gebruikt in dit project:
"proseWrap": "always"
}
```

Voorbeeld van `.markdownlinkt.json`:

```json
{
"default": true,
"MD003": { "style": "atx" },
"MD007": { "indent": 4 },
"MD013": { "line_length": 80, "code_blocks": false, "heading_line_length": 200, "tables": false},
"no-hard-tabs": false
}
```
1 change: 0 additions & 1 deletion docs/ReSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,6 @@ Naamgevinsregels voor pubDomain:
| visu | Visualisatie | respec utils | | | groeperen? |
| vtm | | docs.geostandaarden.nl | is eigenlijk metadata | | verhuizen naar MD |
| wp | Whitepaper Geostandaarden | respec utils | ook een raar pubdomain | | verhuizen naar ngii |
| | | | | | |

## LocalBiblio

Expand Down
1 change: 1 addition & 0 deletions docs/SuggestiesHandleiding.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

# Workflow Modelleur Tips&Tricks

Hieronder volgt een ruwe opsomming van suggesties voor het maken van nieuwe, dan wel uitbreiden van bestaande handleidingen.

> **Note**: Hoe omgaan met onderdelen die regelmatig wijzigen?
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,16 @@ Voor licenties of de interne beheerder van de tooling kun je terecht op
De documentatie van de werkwijze is niet alleen hier vastgelegd. Links naar
andere documenten:

- [werkomgeving modelleren](werkomgeving-modelleren.md).
- [werkwijze modelleren](werkwijze-modelleren.md).
- [geonovum werkwijze modelleren](geonovum-werkwijze-modelleren.md)
- [werkomgeving modelleren](werkomgeving-modelleren.md).
- [werkwijze modelleren](werkwijze-modelleren.md).
- [geonovum werkwijze modelleren](geonovum-werkwijze-modelleren.md)

## Geonovum publicatieomgeving

Verschillende onderdelen van standaarden worden op verschillende plaatsen
gepubliceerd. De publicatieomgeving ziet er als volgt uit

![Architectuurplaatje](media/GeonovumInterneArchitectuur.drawio.png)

![Architectuurplaatje](https://raw.githubusercontent.com/Geonovum/DrawIO/master/GeonovumInterneArchitectuur.drawio.png)
### Documenten (docs.geostandaarden.nl)

Standaarden en technische documentatie. Voor een nette lijst van pubdomains op
Expand All @@ -83,9 +82,10 @@ dit met een webhook kan doen staat beschreven in:

### Ontologieën (begrippen.geostandaarden.nl)


### Conceptenbibliotheek (definities.geostandaarden.nl)

## Uitleg MkDocs
## MkDocs voor deze handleiding

De handleiding wordt beheerd in [MkDocs](https://www.mkdocs.org/). Dit is een
lichtgewicht tool die een collectie Markdown handleidingen omzet in een
Expand Down
Binary file removed docs/media/GeonovumInterneArchitectuur.drawio.png
Binary file not shown.

0 comments on commit 9914d72

Please sign in to comment.