Merge pull request #27 from OS2web/feature/enhance-documentation

5846: More documentation

Author: jekuaitk

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Added documentation on
+  - Purging queue jobs
+  - Modules implementing audit log
+
 ## [1.2.0] - 2025-07-03
 
 - Added drupal 11 compatibility

README.md

@@ -72,7 +72,12 @@ $msg = sprintf('Fetch personal data from service with parameter: %s', $param);
 $this->auditLogger->info('Lookup', $msg);
 ```
 
-### Queue
+### Implementations
+
+See [implementations](/docs/IMPLEMENTATIONS.md) for a list of modules that have
+audit logging integrated.
+
+## Queue
 
 The actual logging is handled by jobs in an [Advanced
 Queue](https://www.drupal.org/project/advancedqueue) queue.
@@ -93,9 +98,22 @@ drush advancedqueue:queue:list
 or go to `/admin/config/system/queues/jobs/os2web_audit` for a
 graphical overview of jobs in the queue.
 
-### Coding standards
+### Purge successful jobs
+
+It is possible to configure the queue to purge jobs based on
+ the number of jobs or the number of days since processing.
+
+Go to `admin/config/system/queues/manage/os2web_audit` to configure this.
+
+Below is an example of purging successful jobs after 7 days.
+
+![queue purge config](/docs/queue_purge_config.png)
+
+Remember to export this to ensure it is not overridden upon config import.
+
+## Coding standards
 
-#### PHP files (PHP_CodeSniffer)
+### PHP files (PHP_CodeSniffer)
 
 Check PHP coding standards
 
@@ -111,15 +129,15 @@ docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest comp
 docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-apply
 ```
 
-### Code analysis
+## Code analysis
 
 phpstan is used to perform static analysis of the code. Run the following script:
 
 ```sh
 ./scripts/code-analysis
 ```
 
-#### Markdown files
+### Markdown files
 
 ```shell
 docker run --interactive --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint '**/*.md' --fix

docs/IMPLEMENTATIONS.md

@@ -0,0 +1,64 @@
+# Implementations
+
+The following contrib modules inject an audit logger.
+
+## OS2Forms submodules
+
+Modules within [os2forms/os2forms](https://github.com/OS2Forms/os2forms) that audit logs:
+
+### [os2forms_fbs_handler](https://github.com/OS2Forms/os2forms/tree/develop/modules/os2forms_fbs_handler)
+
+Audit logs when:
+
+* Patron is created
+
+### [os2forms_digital_post](https://github.com/OS2Forms/os2forms/tree/develop/modules/os2forms_digital_post)
+
+Audit logs when:
+
+* Digital post is sent
+
+### [os2forms_fasit](https://github.com/OS2Forms/os2forms/tree/develop/modules/os2forms_fasit)
+
+Audit logs when:
+
+* File is uploaded to Fasit
+* Document is uploaded to Fasit
+
+### [os2forms_nemid](https://github.com/OS2Forms/os2forms/tree/develop/modules/os2forms_nemid)
+
+Audit logs when:
+
+* User is looking up CPR-number.
+
+## Other modules
+
+### [os2web/os2web_datalookup](https://github.com/OS2web/os2web_datalookup)
+
+Audit logs when:
+
+* Company is queried via CVR-number
+* Company is queried via P-number
+* Person is queried via CPR-number
+
+### [itk-dev/os2forms_nemlogin_openid_connect](https://github.com/itk-dev/os2forms_nemlogin_openid_connect)
+
+Audit logs when:
+
+* Upon OIDC login
+* Upon OIDC logout
+
+### [os2forms/os2forms_get_organized](https://github.com/OS2Forms/os2forms_get_organized)
+
+Audit logs when:
+
+* Case is created
+* Relation is established between documents
+* Documents are finalized (journaliseret)
+* Document is archived to case
+
+### [os2forms/os2forms_organisation](https://github.com/itk-dev/os2forms_organisation)
+
+Audit logs when:
+
+* User is looking up organisation data.