6654: Update documentation

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: turegjorup

CHANGELOG.md

@@ -61,7 +61,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Upgrade to: Symfony 7.2, Doctrine ORM 3.x / DBAL 4.x, Api-platform 4.0, PhpUnit 11 with dependencies
 - Switch to PHPStan
 - Added cleanup for detection results
-- Refactor rootDir normalization to ensure values are always normalized, fix type errors, 
+- Refactor rootDir normalization to ensure values are always normalized, fix type errors,
 - Fix various values not being set
 
 ## [1.7.1] - 2024-11-08

README.md

@@ -7,14 +7,14 @@
 [![GitHub last commit](https://img.shields.io/github/last-commit/itk-dev/devops_itksites?style=flat-square)](https://github.com/itk-dev/devops_itksites/commits/develop/)
 [![GitHub License](https://img.shields.io/github/license/itk-dev/devops_itksites?style=flat-square)](https://github.com/itk-dev/devops_itksites/blob/develop/LICENSE)
 
-
 This is our internal server and site registration tool. It works in tandem with our
 [ITK sites server harvester](https://github.com/itk-dev/devops_itkServerHarvest).
 The harvester is installed by default on all servers, and runs at intervals and collects
 information about sites and installations running on the server. These are sent as
 `DetectionResults` to ITKsites where they are analysed and processed.
 
 This allows us to monitor
+
 * What is installed and running
 * Which sites/domains we are hosting
 * What docker images we are running
@@ -23,13 +23,15 @@ This allows us to monitor
 * What git repositories we are hosting
 
 Additionally we can register and document
+
 * All OpenID Connect setups
 * All Services Certificates
 
 Servers, OpenID Connect setups, Services Certificates must be created and maintained manually.
 All other information is kept up to date by analysing the DetectionResults.
 
 ## Architecture
+
 This is a Symfony 6 project build with api-platform 3.x and EasyAdmin.
 
 Api-platform provides a simple REST api for POST'ing the DetectionResults.
@@ -54,6 +56,7 @@ docker compose exec phpfpm bin/console doctrine:migrations:migrate --no-interact
 Then create a `.env.local` file to set secrets for your local setup.
 
 ### OpenID Connect
+
 All users access is controlled by OpenID Connect. For local development you must
 add the following to your `.env.local` file:
 
@@ -94,11 +97,13 @@ docker compose exec phpfpm bin/console itk-dev:openid-connect:login admin@exampl
 
 All processing of Detctionresults is done in a series of message handlers. To
 run these do either:
+
 ```shell
 docker compose exec phpfpm composer queues
 ```
 
 or
+
 ```shell
 docker compose exec phpfpm bin/console messenger:consume async --failure-limit=1 -vvv
 ```