diff --git a/docs/README.md b/docs/README.md index b8bb7712..14317ca5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,9 @@ ---- +*** + description: >- - Welkom bij de gebruikersdocumentatie voor de OpenCatalogi Nextcloud App. Veel - succes met het gebruik van de app. ---- +Welkom bij de gebruikersdocumentatie voor de OpenCatalogi Nextcloud App. Veel +succes met het gebruik van de app. +---------------------------------- # Welkom @@ -23,4 +24,4 @@ Deze documentatie is bedoeld voor diverse doelgroepen: Voor meer informatie over OpenCatalogi en onze gemeenschappelijke inspanningen, bezoek onze [documentatie-pagina](https://documentatie.opencatalogi.nl) of de officiële website op [OpenCatalogi.nl](https://opencatalogi.nl). -Veel succes met het gebruik van de app. Voor vragen of bijdragen, neem gerust contact met ons op via [support@conduction.nl](mailto:support@conduction.nl). +Veel succes met het gebruik van de app. Voor vragen of bijdragen, neem gerust contact met ons op via . diff --git a/docs/beheerders/README.md b/docs/beheerders/README.md index 41899386..6afccf02 100644 --- a/docs/beheerders/README.md +++ b/docs/beheerders/README.md @@ -1,9 +1,10 @@ ---- +*** + description: >- - De rol van een "Beheerder" binnen het platform is gericht op het beheren van - de publicaties, catalogi en metadata, evenals de autorisatie van gebruikers. - De verantwoordelijkheden van de beheerder: ---- +De rol van een "Beheerder" binnen het platform is gericht op het beheren van +de publicaties, catalogi en metadata, evenals de autorisatie van gebruikers. +De verantwoordelijkheden van de beheerder: +------------------------------------------ # Beheerders diff --git a/docs/developers/README.md b/docs/developers/README.md index 899c3b7e..6130c59a 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -1,9 +1,10 @@ ---- +*** + description: >- - De rol van een "Developer" binnen het publicatieplatform is voornamelijk - gericht om bij te dragen aan de ontwikkeling aan de codebase of om - aanpassingen te kunnen testen of demonstreren. ---- +De rol van een "Developer" binnen het publicatieplatform is voornamelijk +gericht om bij te dragen aan de ontwikkeling aan de codebase of om +aanpassingen te kunnen testen of demonstreren. +---------------------------------------------- # Developers diff --git a/docs/developers/aan-de-slag-met-development.md b/docs/developers/aan-de-slag-met-development.md index 067f491d..c7b9e541 100644 --- a/docs/developers/aan-de-slag-met-development.md +++ b/docs/developers/aan-de-slag-met-development.md @@ -4,16 +4,16 @@ We gaan er voor deze stap vanuit dat je reeds een werkende lokale Nextcloud-omge ## Bijdragen -Als Nextcloud-app volgen we sowieso de [Nextcloud publishing guidelines](https://docs.nextcloud.com/server/19/developer\_manual/app/publishing.html#app-guidelines). +Als Nextcloud-app volgen we sowieso de [Nextcloud publishing guidelines](https://docs.nextcloud.com/server/19/developer_manual/app/publishing.html#app-guidelines). Daarbovenop hanteren we een aantal extra spelregels: * **Features moeten zijn voorzien van gebruikersdocumentatie** -* **Backend code moet zijn voorzien van automatische tests**: Code die coverage van het project verlaagd wordt niet geaccepteerd, zie ook [PHP-unit testing](https://docs.nextcloud.com/server/latest/developer\_manual/server/unit-testing.html). -* **Backend code moet zuiver zijn**: Code mag _géén_ linting errors bevatten +* **Backend code moet zijn voorzien van automatische tests**: Code die coverage van het project verlaagd wordt niet geaccepteerd, zie ook [PHP-unit testing](https://docs.nextcloud.com/server/latest/developer_manual/server/unit-testing.html). +* **Backend code moet zuiver zijn**: Code mag *géén* linting errors bevatten * **Frontend code moet zijn voorzien van automatische tests**: Code die coverage van het project verlaagd wordt niet geaccepteerd -* **Frontend code moet zuiver zijn**: Code mag _géén_ linting errors bevatten -* **Seperation of concerns**: Voor zowel backend als frontend moet business logica zijn opgenomen in Services. Dat betekent dat Controllers, Templates, Views, Componenten en Store _géén_ business logica mogen bevatten. +* **Frontend code moet zuiver zijn**: Code mag *géén* linting errors bevatten +* **Seperation of concerns**: Voor zowel backend als frontend moet business logica zijn opgenomen in Services. Dat betekent dat Controllers, Templates, Views, Componenten en Store *géén* business logica mogen bevatten. * **Vier ogen-principe**: Pull requests moeten zijn beoordeeld door een andere developer dan de maker voordat ze worden geaccepteerd * **Automatische test**: Code mag alleen naar master/main als alle automatische tests goed gaan * **Vraag gestuurde development**: Code wordt alleen geaccepteerd als deze is gekoppeld aan een door de PO goedgekeurde user story ([regel](https://github.com/OpenCatalogi/.github/issues/new/choose)) @@ -24,11 +24,11 @@ In de meeste gevallen zal een wijzigingsvoorstel voor de OpenCatalogi Nextcloud De Ontwikkelpartijen van [Core](https://documentatie.opencatalogi.nl/Docs/Projecten/) fungeren tevens als beheerpartijen voor de code base. -![alt text](feature\_flow.png) +![alt text](feature_flow.png) ## Application development -Omdat de applicatie is ontwikkeld met Nextcloud, is er uitgebreide informatie te vinden in de [Nextcloud-documentatie](https://docs.nextcloud.com/server/latest/developer\_manual/index.html) zelf. Dit geldt zowel voor de lay-out van de app als voor de vele componenten die eraan toegevoegd kunnen worden. Tijdens de ontwikkeling van de OpenCatalogi-app is het _documentation-first_ principe gehanteerd, waarbij de ontwikkelaars eerst de [Nextcloud-documentatie](https://docs.nextcloud.com/server/latest/developer\_manual/index.html) hebben geraadpleegd. +Omdat de applicatie is ontwikkeld met Nextcloud, is er uitgebreide informatie te vinden in de [Nextcloud-documentatie](https://docs.nextcloud.com/server/latest/developer_manual/index.html) zelf. Dit geldt zowel voor de lay-out van de app als voor de vele componenten die eraan toegevoegd kunnen worden. Tijdens de ontwikkeling van de OpenCatalogi-app is het *documentation-first* principe gehanteerd, waarbij de ontwikkelaars eerst de [Nextcloud-documentatie](https://docs.nextcloud.com/server/latest/developer_manual/index.html) hebben geraadpleegd. ## Kwaliteit, Stabiliteit en Veiligheid @@ -46,7 +46,7 @@ Voor frontend gebruiken we ESLint, de installatiehandleiding is [hier](https://w npm run lint ``` -![alt text](npm\_lint.png) +![alt text](npm_lint.png) #### Backend @@ -69,7 +69,7 @@ Voor het uitvoeren van de unit tests gebruiken we aan de frontend Jest. Indien j npm run test-coverage ``` -![alt text](npm\_test.png) +![alt text](npm_test.png) #### Backend: @@ -79,7 +79,7 @@ Voor het uitvoeren van de unit tests gebruiken we aan de backend PHPunit. Indien phpunit ``` -> **NOTE 1** We volgen de Nextcloud wijze voor unit testing, zie hier voor [de details](https://docs.nextcloud.com/server/latest/developer\_manual/server/unit-testing.html), maar dit komt neer op [phpunit](https://docs.phpunit.de/en/11.3/index.html) en de juist configuratie van `phpunit.xml`en de `bootstrap.php`. Een voorbeeld van deze files zijn te vinden in de `root` van de applicatie (`phpunit.xml`) en de `/tests/unit`(`bootstrap.php`). Er zijn veel mogelijkheden om het jezelf makkelijk te maken, zoals een percentageoverzicht in de terminal. Het commando dat wij gebruiken is : +> **NOTE 1** We volgen de Nextcloud wijze voor unit testing, zie hier voor [de details](https://docs.nextcloud.com/server/latest/developer_manual/server/unit-testing.html), maar dit komt neer op [phpunit](https://docs.phpunit.de/en/11.3/index.html) en de juist configuratie van `phpunit.xml`en de `bootstrap.php`. Een voorbeeld van deze files zijn te vinden in de `root` van de applicatie (`phpunit.xml`) en de `/tests/unit`(`bootstrap.php`). Er zijn veel mogelijkheden om het jezelf makkelijk te maken, zoals een percentageoverzicht in de terminal. Het commando dat wij gebruiken is : `XDEBUG_MODE=coverage phpunit --bootstrap ./tests/bootstrap.php --configuration phpunit.xml --coverage-html ./coverage --coverage-text | tee coverage.txt` @@ -93,7 +93,7 @@ phpunit npm audit ``` -![alt text](npm\_audit.png) +![alt text](npm_audit.png) #### Backend @@ -101,7 +101,7 @@ npm audit composer audit ``` -![alt text](composer\_audit.png) +![alt text](composer_audit.png) Voor beide geldt dat het aantal acceptabele critical vulnerabilities 0 is. @@ -143,5 +143,5 @@ Daarnaast gebruiken we Typescript voor het definiëren van entities. Het is goed om bij development kennnis te nemen/hebben van de volgende gebruikte Nextcloud onderdelen: * [Icons](https://pictogrammers.com/library/mdi/) -* [Layout](https://docs.nextcloud.com/server/latest/developer\_manual/design/layout.html)- +* [Layout](https://docs.nextcloud.com/server/latest/developer_manual/design/layout.html)- * [Componenten](https://nextcloud-vue-components.netlify.app/) diff --git a/docs/gebruikers/README.md b/docs/gebruikers/README.md index a95535e3..8544890f 100644 --- a/docs/gebruikers/README.md +++ b/docs/gebruikers/README.md @@ -1,9 +1,10 @@ ---- +*** + description: >- - Een "Gebruiker" binnen het Publicatieplatform heeft de primaire taak om - publicaties te creëren en te bewerken. De rol van de gebruiker omvat de - volgende verantwoordelijkheden en mogelijkheden: ---- +Een "Gebruiker" binnen het Publicatieplatform heeft de primaire taak om +publicaties te creëren en te bewerken. De rol van de gebruiker omvat de +volgende verantwoordelijkheden en mogelijkheden: +------------------------------------------------ # Gebruikers diff --git a/docs/gebruikers/dashboard.md b/docs/gebruikers/dashboard.md index 2b06bc44..c94f4905 100644 --- a/docs/gebruikers/dashboard.md +++ b/docs/gebruikers/dashboard.md @@ -1,8 +1,9 @@ ---- +*** + description: >- - Deze handleiding gaat ervan uit dat de gebruiker beschikt tot een werkende - OpenCatalogi-Nextcloud app ---- +Deze handleiding gaat ervan uit dat de gebruiker beschikt tot een werkende +OpenCatalogi-Nextcloud app +-------------------------- # Dashboard @@ -18,7 +19,7 @@ Op het dashboard van OpenCatalogi vindt u handige informatie die je meteen verde 2. **Metadata** De verdeling over metadata-types van jouw publicaties 3. **Status** De verdeling over statustypes van jouw publicaties -![app menu](../assets/oc\_dashboard.png) +![app menu](../assets/oc_dashboard.png) ### Sidebar diff --git a/docs/gebruikers/publicaties.md b/docs/gebruikers/publicaties.md index 1fbbc61a..87b1a8a1 100644 --- a/docs/gebruikers/publicaties.md +++ b/docs/gebruikers/publicaties.md @@ -46,8 +46,6 @@ Publicaties hebben vaak bijlagen, zoals een verslag of een besluit. Deze zijn ee

bijlage toevoegen via drie bolletjes

- -

bijlage toevoegen via de actie-knop