developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

Hoe schrijf ik een gastblog?

Wil jij je stem laten horen via onze blog? Omdat wij het belang zien van een breedgedragen discussie helpen we jou hier graag bij.

Markdown​

  • Een bijdrage aan onze blog dien je in alle gevallen aan te dragen als Markdown bestand.
  • Een markdown bestand heeft de .md bestandsextensie.
  • De filename van jouw blog ziet er bijvoorbeeld zo uit: mijn-blog-over-grafana.md.

Voorbeeld​

Voorbeeld van correct geformatteerde blogpost in markdown
---
authors: [martin-van-der-plas]
description:
  "Een korte beschrijving van je blogpost voor bijvoorbeeld zoekmachines en de
  RSS-feed."
image: ./img/mijn-preview-afbeelding.png
tags:
  - interoperabiliteit
draft: true
---

# Titel

Dit is de intro met een hele pakkende tekst om op "Lees meer" te klikken.

<!-- truncate -->

## Kop 2

En hier gaat het verhaal weer verder.

### Kop 2.1

Lorem ipsum.
  • description is verplicht — wordt gebruikt in de RSS-feed en als meta-beschrijving. Gebruik bij voorkeur de eerste zin van je blogpost.
  • image is optioneel maar aanbevolen — wordt gebruikt als preview bij het delen op sociale media (Open Graph). Plaats de afbeelding in dezelfde map of een img/-submap.

Tags​

Blogposts gebruiken dezelfde tags als kennisbankartikelen. Alle tags moeten voorkomen in tags.yml.

Thema-tags (verplicht, 1-3)​

Elk artikel heeft minimaal 1 en maximaal 3 thema-tags:

TagBeschrijving
informatiebeveiligingSecurity, authenticatie, encryptie
interoperabiliteitData-uitwisseling, API's, standaarden
toegankelijkheidWCAG, inclusiviteit, UX
privacyAVG, gegevensbescherming, logging
infrastructuurKubernetes, deployment, cloud
front-endUI, design systems, libraries
open-sourceLicenties, community, governance

Onderwerp-tags (optioneel, 0-5)​

Specifieke technologieën, standaarden of concepten (bijv. oauth, kubernetes, react).

Organisatie-tags (optioneel)​

Bijvoorbeeld: forum-standaardisatie, kennisplatform-apis, vng, common-ground.

Regels​

  • Maximaal 8 tags totaal per blogpost.
  • Content types (standaard, tool, tutorial, architectuur, richtlijn) mogen nooit als tag voorkomen.
  • Een onbekende tag laat de build falen.

Er zijn verschillende manieren om een gastblog aan te dragen:

Stuur ons een e-mail​

Stuur een e-mail naar developer.overheid@geonovum.nl met het markdown-bestand van jouw blogpost.

Maak een Gist en dien een issue in​

Je kunt een artikel schrijven in Markdown en deze als een Gist opslaan. Zorg ervoor dat je de Gist openbaar maakt en de link naar de Gist deelt in een issue.

Maak een Pull Request​

Ook is het mogelijk om een blogpost aan te bieden door middel van een pull request. Hierbij moet je wel op de volgende zaken letten:

  1. Het bestand moet in de draft map staan: /blog/draft/example.md.
  2. In de frontmatter moet draft: true staan (zie voorbeeld hierboven).
  3. Na de intro moet er <!-- truncate --> staan (zie voorbeeld hierboven).
  4. De waarden die ingevuld zijn bij authors moeten voorkomen in het bestand /blog/authors.yml. Ben je een nieuwe auteur, dan kun je jezelf hieraan toevoegen.

Als je nog geen lid bent van onze repository, maak dan eerst een fork. Deze fork kun je vervolgens aanbieden als pull request bij ons.