Skip to content

Commit

Permalink
Merge pull request #9 from Logius-standaarden/review-rc
Browse files Browse the repository at this point in the history
Release review 2023
  • Loading branch information
sanderke committed Jul 7, 2023
2 parents b096d87 + f660240 commit 168d660
Show file tree
Hide file tree
Showing 15 changed files with 319 additions and 569 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/aanpassing_documentatie.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Aanpassing op documentatie
description: Stel een (tekstueele) wijziging voor in de documentatie van de Digikoppeling standaard
title: "RFC ..."
labels: ["digikoppeling", "documentatie"]
body:
- type: checkboxes
id: standaard
attributes:
label: Soort
description: Om wat voor wijziging gaat het?
options:
- label: Tekstuele fout
- label: Verbetersuggestie
- label: Onduidelijke tekst
- type: textarea
id: omschrijving
attributes:
label: Omschrijving
description: Wat is de voorgestelde wijziging? Op welke pagina of sectie staat het?
placeholder: Tik hier uw voorgestelde wijziging
validations:
required: true
- type: input
id: contact
attributes:
label: Naam
description: Naam. Uw naam wordt online getoond in het issue. U kunt ook anoniem invullem.
validations:
required: false
- type: input
id: email
attributes:
label: Email
description: E-mail adres. Uw e-mail adres wordt online getoond in het issue. U kunt ook anoniem invullem.
validations:
required: false
- type: input
id: organisatie
attributes:
label: Organisatie
description: Naam van uw organisatie. Dit veld is verplicht omdat we deze in het overzicht opnemen.
validations:
required: true
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/opmerkingen.md

This file was deleted.

26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/vragen.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/wijzigingsformulier.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Wijzigingsformulier
description: Stel een (inhoudelijke) wijziging voor op de Digikoppeling standaard. Voor een tekstueele wijziging op de documentatie bestaat een ander formulier.
title: "RFC ..."
labels: ["Standaard: digikoppeling", "Type: wijziging"]
body:
- type: textarea
id: omschrijving
attributes:
label: Omschrijving
description: Wat is de voorgestelde wijziging?
placeholder: Vul hier de voorgestelde aanpassing in
validations:
required: true
- type: input
id: contact
attributes:
label: Naam
description: Naam. Uw naam wordt online getoond in het issue. U kunt ook anoniem invullem.
validations:
required: false
- type: input
id: email
attributes:
label: Email
description: E-mail adres. Uw e-mail adres wordt online getoond in het issue. U kunt ook anoniem invullem.
validations:
required: false
- type: input
id: organisatie
attributes:
label: Organisatie
description: Naam van uw organisatie. Dit veld is verplicht omdat we deze in het overzicht opnemen.
validations:
required: true
98 changes: 20 additions & 78 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,78 +1,20 @@
name: Build and Check
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
jobs:
build:
name: Build
uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main
check:
needs: build
name: Check
uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main

release:
needs: build
name: Release
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push'}}
steps:
- uses: actions/checkout@v2
- name: Recover HTML
uses: actions/cache@v2
with:
path: ~/static
key: ${{ github.run_id }}
- name: Gather files
run: |
rm -f *.md *.html
mv ~/static/snapshot.html index.html
mkdir content
shopt -s extglob
mv !(content) content
git clone https://user:${{ secrets.BEHEER }}@github.com/Logius-standaarden/publicatie.git
- name: Commit release
run: |
wget https://raw.githubusercontent.com/Logius-standaarden/Automatisering/main/scripts/release.py
python release.py
cd publicatie
git add -A
git config user.name "GitHub Action"
git config user.email "api@logius.nl"
git commit -m "Release: ${{ github.event.repository.name }}"
git push
preview:
needs: build
name: Preview
runs-on: ubuntu-latest
if: ${{ github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork }}
steps:
- uses: actions/checkout@v2
- name: Recover HTML
uses: actions/cache@v2
with:
path: ~/static
key: ${{ github.run_id }}
- name: Gather files
run: |
rm index.html
mv ~/static/snapshot.html index.html
rm -f *.md *.pdf *.js snapshot.html
mkdir ~/content
mv ./* ~/content
git clone https://user:${{ secrets.BEHEER }}@github.com/Logius-standaarden/Publicatie-Preview.git
- name: Commit preview
run: |
cd Publicatie-Preview
rm -f -r ${{ github.event.repository.name }}/${{ github.head_ref }}
mkdir -p ${{ github.event.repository.name }}/${{ github.head_ref }}
mv ~/content/* ${{ github.event.repository.name }}/${{ github.head_ref }}
git add -A
git config user.name "GitHub Action"
git config user.email "api@logius.nl"
git commit -m "new preview build"
git push
name: Build and Check
on:
workflow_dispatch:
pull_request:
push:
branches:
- main
jobs:
build:
name: Build
uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main
check:
needs: build
name: Check
uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main
publish:
needs: build
name: Publish (Logius)
uses: Logius-standaarden/Automatisering/.github/workflows/publish.yml@main
secrets: inherit
15 changes: 8 additions & 7 deletions 02_documentbeheer.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Documentbeheer

| Datum | Versie | Auteur | Opmerkingen |
|------------|--------|--------|-------------|
| 22-11-2011 | 1.5 | Logius | - |
| 09-06-2014 | 1.6 | Logius | Redactioneel bijwerken |
| 13-01-2015 | 3.0 | Logius | Redactioneel |
| Datum | Versie | Auteur | Opmerkingen |
|------------|--------|--------|-----------------------------------------------------------------------------|
| 22-11-2011 | 1.5 | Logius | - |
| 09-06-2014 | 1.6 | Logius | Redactioneel bijwerken |
| 13-01-2015 | 3.0 | Logius | Redactioneel |
| 01-10-2017 | 3.1 | Logius | Herzien nav: - Compliance Voorziening - Begrippen ebMS2 en CPA Register |
| 16-05-2019 | 3.2 | Logius | EB015 SyncReply toegevoegd |
| 11/04/2022 | 3.2.1 | Logius | Vermelding REST-API koppelvlak |
| 16-05-2019 | 3.2 | Logius | EB015 SyncReply toegevoegd |
| 11-04-2022 | 3.2.1 | Logius | Vermelding REST-API koppelvlak |
| 31-05-2023 | 3.2.2 | Logius | Update 2023 conform Roadmap Digikoppeling, review |
3 changes: 2 additions & 1 deletion 03_colofon.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@

| | |
|---|---|
| Logius Servicecentrum: | Postbus 96810 2509<br>JE Den Haag<br>t. 0900 555 4555 (10 ct p/m)<br>e.<servicecentrum@logius.nl> |
| Logius Servicecentrum: | Postbus 96810 <br>2509 JE Den Haag<br>tel. 0900 555 4555 (10 ct p/m)<br>email servicecentrum@logius.nl |
| Logius Afdeling Standaarden: | email. digikoppeling@logius.nl<br> |
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Digikoppeling Best Practices ebMS2

- html: https://logius-standaarden.github.io/Digikoppeling-Best-Practices-ebMS2/
- html(static): https://logius-standaarden.github.io/Digikoppeling-Best-Practices-ebMS2/snapshot.html
- PDF-versie: https://github.com/Logius-standaarden/Digikoppeling-Best-Practices-ebMS2/blob/master/Digikoppeling-Best-Practices-ebMS2.pdf
- Werkversie: https://logius-standaarden.github.io/Digikoppeling-Best-Practices-ebMS2/
- Gepubliceerde versie (HTML): https://gitdocumentatie.logius.nl/publicatie/dk/bpebms/
- Gepubliceerde versie (PDF): https://gitdocumentatie.logius.nl/publicatie/dk/bpebms/Digikoppeling-Best-Practices-ebMS2.pdf
28 changes: 14 additions & 14 deletions ch01_Inleiding.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Inleiding

## Doel en doelgroep

Alle Digikoppeling profielen die op ebMS2 gebaseerd zijn, moeten zich conformeren aan de Koppelvlakstandaard ebMS2. Dit document is een aanvulling hierop. Het heeft als doel ontwikkelaars te adviseren en te informeren over de huidige werkwijze bij het toepassen van Digikoppeling Koppelvlakstandaard ebMS2 – deze informatie geldt dus alleen voor de ebMS2-variant.
Expand All @@ -16,10 +17,8 @@ Het document is bestemd voor Architecten, integratie specialisten en ontwikkelaa

Digikoppeling is beschreven in een set van documenten. Deze set is als volgt opgebouwd:


![Overzicht van de onderdelen van de Digikoppeling Standaard, de standaard is onderverdeeld in normatieve en ondersteunende onderdelen](media/DK_Specificatie_structuur.svg "Opbouw documentatie Digikoppeling")


<details>
<summary> Tekstalternatief </summary>
<ul>
Expand Down Expand Up @@ -86,26 +85,27 @@ Digikoppeling biedt de mogelijkheid om op deze gestandaardiseerde wijze berichte

De uitwisseling tussen partijen is in drie lagen opgedeeld:

- Inhoud (gegevens): deze laag bevat afspraken over de inhoud van het uit te wisselen bericht, dus de structuur, semantiek en waardebereiken
Digikoppeling houdt zich niet met de inhoud bezig, ' heeft geen boodschap aan de boodschap'.
1. Inhoud (gegevens): deze laag bevat afspraken over de inhoud van het uit te wisselen bericht, dus de structuur, semantiek en waardebereiken <BR>
Digikoppeling houdt zich niet met de inhoud bezig, '_heeft geen boodschap aan de boodschap_'.

- Logistiek (processen): op deze laag bevinden zich de afspraken betreffende transportprotocollen (HTTP/TLS), messaging (SOAP), adressering, beveiliging (authenticatie en encryptie) en betrouwbaarheid. Dit is laag van Digikoppeling.
2. Logistiek (processen): op deze laag bevinden zich de afspraken betreffende transportprotocollen (HTTP/TLS), messaging (SOAP), adressering, beveiliging (authenticatie en encryptie) en betrouwbaarheid. Dit is laag van Digikoppeling.

- Transport (techniek): deze laag verzorgt het daadwerkelijke transport van het bericht (TCP/IP).
3. Transport (techniek): deze laag verzorgt het daadwerkelijke transport van het bericht (TCP/IP).

Digikoppeling richt zich uitsluitend op de logistieke laag.
> Digikoppeling richt zich uitsluitend op de logistieke laag.
## Opbouw van dit document

Hoofdstuk 1 bevat een aantal algemene inleidende onderwerpen.

Hoofdstuk 2 bevat de aanbevelingen, werkwijze en best practices.
[Hoofdstuk 1 bevat een aantal algemene inleidende onderwerpen.](#inleiding)

Hoofdstuk 3 gaat in op de kenmerken van een CPA.
[Hoofdstuk 2 bevat de aanbevelingen, werkwijze en best practices.](#werkwijze-aanbevelingen-best-practices)

Hoofdstuk 4 gaat over bericht volgordelijkheid.
[Hoofdstuk 3 gaat in op de kenmerken van een CPA.](#cpa-gebruik-en-kenmerken)

Begrippen en afkortingen worden toegelicht in het document “DigikoppelingArchitectuur”. Deze zit in de Digikoppeling standaard.
[Hoofdstuk 4 gaat over bericht volgordelijkheid.](#het-gebruik-van-berichtvolgordelijkheid)

Dit document en andere documentatie is beschikbaar op [www.logius.nl/digikoppeling](http://www.logius.nl/digikoppeling).
> Begrippen en afkortingen worden toegelicht in het document [[Digikoppeling-Architectuur]].
> Dit document is onderdeel van de Digikoppeling standaard.
<div class="note">Dit document en alle andere Digikoppeling documentatie is beschikbaar op [de website van Logius](http://www.logius.nl/digikoppeling).
</div>
Loading

0 comments on commit 168d660

Please sign in to comment.