Merge branch 'docs' into development

.github/workflows/CI-workflows.yaml

@@ -0,0 +1,120 @@
+name: CI Workflow
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          extensions: mbstring, zip, xml, curl, intl, sqlite, gd, pdo_mysql
+          tools: cs2pr, phpcbf, phpcs, phpmd, phpunit
+
+      - name: Install Composer dependencies
+        run: composer install
+
+      - name: Run phpcbf
+        run: phpcbf .
+        continue-on-error: ${{ github.ref != 'refs/heads/main' }}
+
+      - name: Commit code formatting changes
+        if: success() && github.ref != 'refs/heads/main'
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "[email protected]"
+          git add src
+          git diff --cached --quiet || (git commit -m "Update src from PHP Codesniffer" && git pull origin $(git rev-parse --abbrev-ref HEAD) --rebase --autostash && git push)
+
+      - name: Run phpcs
+        run: phpcs -q --report=checkstyle src | cs2pr
+        continue-on-error: ${{ github.ref != 'refs/heads/main' }}
+
+      - name: Run phpmd
+        run: phpmd src xml phpmd.xml --not-strict
+        continue-on-error: ${{ github.ref != 'refs/heads/main' }}
+
+      - name: List files in repository root
+        run: ls -alh
+
+      - name: List files in tests directory
+        run: ls -alh ./tests
+
+      - name: List files in vendor directory
+        run: ls -alh ./vendor
+
+      - name: Run PHPUnit tests
+        env:
+          XDEBUG_MODE: coverage
+        run: |
+          phpunit --bootstrap ./tests/bootstrap.php --configuration phpunit.xml --coverage-html ./coverage --coverage-text | tee coverage.txt
+        continue-on-error: ${{ github.ref != 'refs/heads/main' }}
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install remark presets
+        run: npm install remark-cli remark-preset-lint-consistent remark-preset-lint-recommended remark-lint-list-item-indent
+      - name: Run remark
+        run: npx remark . --output --use remark-preset-lint-consistent --use remark-preset-lint-recommended --use remark-lint-list-item-indent
+      - name: Check for linting errors
+        run: |
+          npx remark . --use remark-preset-lint-consistent --use remark-preset-lint-recommended --use remark-lint-list-item-indent
+        continue-on-error: ${{ github.ref != 'refs/heads/main' }}
+      - name: Git commit
+        if: success() && github.ref != 'refs/heads/main'
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "[email protected]"
+          git add .
+          git add package.json package-lock.json
+          git diff --cached --quiet || (git commit -m "Update src from remark-lint" && git pull origin $(git rev-parse --abbrev-ref HEAD) --rebase --autostash && git push)
+
+  checks:
+    needs: [build, lint]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP (for checks)
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          extensions: mbstring, zip, xml, curl, intl, sqlite, gd, pdo_mysql
+          tools: cs2pr, phpcs, phpmd, phpunit
+
+      - name: Run Checks
+        run: |
+          if ! command -v phpcs &> /dev/null; then
+            echo "phpcs could not be found. Please ensure it's installed."
+            exit 1
+          fi
+          if ! command -v phpmd &> /dev/null; then
+            echo "phpmd could not be found. Please ensure it's installed."
+            exit 1
+          fi
+          if phpcs -q --report=checkstyle src | grep -q "ERROR"; then
+            echo "PHP CodeSniffer found issues. Please fix them before merging."
+            exit 1
+          fi
+          if phpmd src xml phpmd.xml --strict | grep -q "ERROR"; then
+            echo "PHP Mess Detector found issues. Please fix them before merging."
+            exit 1
+          fi
+          # if ! phpunit --bootstrap ./tests/bootstrap.php --configuration phpunit.xml; then
+          #  echo "PHPUnit tests failed. Please fix them before merging."
+          #  exit 1
+          #fi
+          if ! npx remark . --use remark-preset-lint-consistent --use remark-preset-lint-recommended --use remark-lint-list-item-indent; then
+            echo "Markdown linting failed. Please fix them before merging."
+            exit 1
+          fi
+        continue-on-error: false

docs/README.md

@@ -1,9 +1,10 @@
----
+***
+
 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.
 coverY: 0
----
+---------
 
 # Welkom
 
@@ -22,4 +23,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 [[email protected]](mailto:[email protected]).
+Veel succes met het gebruik van de app. Voor vragen of bijdragen, neem gerust contact met ons op via <[email protected]>.

docs/SUMMARY.md

@@ -19,9 +19,9 @@
   * [Installatie van Nextcloud Development-omgeving](developers/installatie-van-nextcloud-development-omgeving.md)
 * [Installatie/productie](installatie/README.md)
   * [Installatie-instructies Nextcloud](installatie/instructies.md)
-  * [Audit en logging](installatie/logging.md) 
-  * [Rollen en Rechten](installatie/rollen-en-rechten.md.md) 
-  * [SAAS](installatie/saas.md) 
+  * [Audit en logging](installatie/logging.md)
+  * [Rollen en Rechten](installatie/rollen-en-rechten.md.md)
+  * [SAAS](installatie/saas.md)
   * [On-Prem server](installatie/on-prem-server.md)
   * [Systeemeisen voor Nextcloud](installatie/systeemeisen-voor-nextcloud.md)
 * [Veel gestelde vragen](f-a-g.md)

docs/beheerders/README.md

@@ -1,2 +1 @@
 # beheerders
-

docs/beheerders/catalogi.md

@@ -12,13 +12,13 @@ De organisatie-eigen catalogi (waartoe een gebruiker toegang heeft) zijn opgenom
 
 Catalogi kunnen worden beheerd via het menu-item Instellingen -> Catalogi.
 
-- **Configuratie**: Onder de configuratie van een catalogus kan worden aangegeven
-  - Of deze actief is (anders wordt de catalogus niet getoond in het navigatiemenu en de zoekresultaten)
-  - Of deze openbaar is (anders wordt de catalogus alleen getoond aan de geselecteerde gebruikersgroepen)
-- **Rollen selecteren**: Hier kunnen de rollen worden geselecteerd die toegang hebben tot de catalogus indien deze **niet** openbaar is.
-- **Metadata selecteren**: Hier kunnen de metadatatypen worden aangegeven die worden geaccepteerd door deze catalogus, dat kunnen zowel [interne metadatatypen](metadata.md) zijn als [externe metadatatypen](directory.md). Deze laatste moeten dan wel zijn geactiveerd via de directory.
+* **Configuratie**: Onder de configuratie van een catalogus kan worden aangegeven
+  * Of deze actief is (anders wordt de catalogus niet getoond in het navigatiemenu en de zoekresultaten)
+  * Of deze openbaar is (anders wordt de catalogus alleen getoond aan de geselecteerde gebruikersgroepen)
+* **Rollen selecteren**: Hier kunnen de rollen worden geselecteerd die toegang hebben tot de catalogus indien deze **niet** openbaar is.
+* **Metadata selecteren**: Hier kunnen de metadatatypen worden aangegeven die worden geaccepteerd door deze catalogus, dat kunnen zowel [interne metadatatypen](metadata.md) zijn als [externe metadatatypen](directory.md). Deze laatste moeten dan wel zijn geactiveerd via de directory.
 
-> [warning] Het is niet mogelijk om een catalogus te verwijderen als deze nog publicaties bevat.
+> \[warning] Het is niet mogelijk om een catalogus te verwijderen als deze nog publicaties bevat.
 
 ## Publicaties verplaatsen
 

docs/beheerders/directory.md

@@ -1,2 +1 @@
 # Directory
-

docs/beheerders/metadata.md

@@ -24,24 +24,24 @@ Metadata definieerd objecten door de opgegeven properties, hiervoor wordt [json-
 
 De voornaamste manieren om een eigenschap te definiëren zijn:
 
-- **type** (verplicht) Het type van de waarde, bijvoorbeeld `string` of `url`
-- **format**: De indeling van de waarde Bijvoorbeeld `date-time` of `url`
-- **requered**: Of de waarde verplicht aanwezig moet zijn
-- **patern**: Een [regex](https://en.wikipedia.org/wiki/Regular_expression) definitie waar de waarde aan moet voldoen
+* **type** (verplicht) Het type van de waarde, bijvoorbeeld `string` of `url`
+* **format**: De indeling van de waarde Bijvoorbeeld `date-time` of `url`
+* **requered**: Of de waarde verplicht aanwezig moet zijn
+* **patern**: Een [regex](https://en.wikipedia.org/wiki/Regular_expression) definitie waar de waarde aan moet voldoen
 
 Voor alle waardes, mogelijke invullingen en gevolgen kan je het beste een kijkje nemen in het [property object](https://conduction.stoplight.io/docs/open-catalogi/d0ci97hdxnctp-property).
 
 ## Archiveren
 
 Metadata objecten zijn vormend voor de bewaartermijn van objecten, hierin volgen we [MDTO](https://www.nationaalarchief.nl/archiveren/mdto/begrippenlijst-metagegevensschema#collapse-102681) en de [VNG](chrome-extension://efaidnbmnnnibpcajpcglclefindmkaj/https://vng.nl/sites/default/files/2020-02/selectielijst_20200214.pdf) selectie lijst. Met andere woorden:
 
-- Iedere metadata heeft een waardeerding B,V of N (standaard N)
-- Als de waardering V is dan moet het termijn zijn opgegeven als klasse
-- De definering van klasse is
-  - 1: 1 Jaar
-  - 2: 5 Jaar
-  - 3: 10 Jaar
-  - 4: 20 Jaar
-  - 5: 50 Jaar
+* Iedere metadata heeft een waardeerding B,V of N (standaard N)
+* Als de waardering V is dan moet het termijn zijn opgegeven als klasse
+* De definering van klasse is
+  * 1: 1 Jaar
+  * 2: 5 Jaar
+  * 3: 10 Jaar
+  * 4: 20 Jaar
+  * 5: 50 Jaar
 
 Bij het aanmaken van een publicatie wordt vervolgens de `archive.date` gezet op de `createDate` + doorlooptijd van de klasse.

docs/beheerders/organisaties.md

@@ -1 +1 @@
-# Organisaties
+# Organisaties

docs/beheerders/themas.md

@@ -1 +1 @@
-# Thema's
+# Thema's

docs/developers/README.md

@@ -1,2 +1 @@
 # developers
-