From 2f22387100607a5a0bb7a29ab1ae5d4e4ce956b3 Mon Sep 17 00:00:00 2001
From: Ayobami Haastrup <47716486+AyobamiH@users.noreply.github.com>
Date: Fri, 28 Aug 2026 09:53:28 +0000
Subject: [PATCH] Update markdownlint-cli and observability headings
Closes #315
---
practices/observability.md | 6 ++++--
scripts/markdown-check-format.sh | 4 ++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/practices/observability.md b/practices/observability.md
index fcdac957..0e895822 100644
--- a/practices/observability.md
+++ b/practices/observability.md
@@ -179,7 +179,8 @@ The [Site Reliability Workbook](https://landing.google.com/sre/workbook/chapters
The [SRE book](https://landing.google.com/sre/sre-book/chapters/monitoring-distributed-systems/) discusses two types of monitoring:
-**Clear-box monitoring**
+### Clear-box monitoring
+
> Monitoring based on metrics exposed by the internals of the system, including logs, interfaces like the Java Virtual Machine Profiling Interface, or an HTTP handler that emits internal statistics.
Examples include:
@@ -189,7 +190,8 @@ Examples include:
- Publishing internal metrics from a component as CloudWatch [custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html), either by pushing them to CloudWatch using the SDK or by using [metric filters](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/MonitoringLogData.html#search-filter-concepts) to extract metrics from application logs in [CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html).
- Using [Java Management Extensions](https://en.wikipedia.org/wiki/Java_Management_Extensions) (JMX) to collect internal metrics from an instrumented Java component.
-**Opaque-box monitoring**
+### Opaque-box monitoring
+
> Testing externally-visible behaviour as a user would see it.
Examples include:
diff --git a/scripts/markdown-check-format.sh b/scripts/markdown-check-format.sh
index bb2399e1..a8cb5f6e 100755
--- a/scripts/markdown-check-format.sh
+++ b/scripts/markdown-check-format.sh
@@ -13,10 +13,10 @@
files=$((git diff --diff-filter=ACMRT --name-only origin/${BRANCH_NAME:-main}.. "*.md"; git diff --name-only "*.md") | sort | uniq)
if [ -n "$files" ]; then
- image=ghcr.io/igorshubovych/markdownlint-cli@sha256:df7ce7cdcdb525d52a89d7aab17c507d49adceaddf2b767d3ed799c9537ded80 # v0.32.2
+ image=ghcr.io/igorshubovych/markdownlint-cli@sha256:905baf9f6bd11da2ede8c394882c616509385f24b8b8d54fff6e111be88f39de # v0.49.1
docker run --rm \
-v $PWD:/workdir \
$image \
$files \
- --disable MD013 MD033
+ --disable MD013 MD033 MD055 MD056 MD058 MD059 MD060
fi