switch markdownlint container to markdownlint-cli2

Also fix all of the markdownlint issues.

Signed-off-by: Tuomo Tanskanen <tuomo.tanskanen@est.tech>

.markdownlint-cli2.yaml

@@ -0,0 +1,9 @@
+# Reference: https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2yaml
+
+config:
+ ul-indent:
+ # Kramdown wanted us to have 3 earlier, tho this CLI recommends 2 or 4
+ indent: 3
+
+# Don't autofix anything, we're linting here
+fix: false

VERSIONING.md

@@ -20,37 +20,37 @@ Cluster API follows [Semantic Versioning](https://semver.org).
 I'd recommend reading the aforementioned link if you're not familiar,
 but essentially, for any given release X.Y.Z:
 
-- an X (*major*) release indicates a set of backwards-compatible code.
+- an X (**major**) release indicates a set of backwards-compatible code.
  Changing X means there's a breaking change.
 
-- a Y (*minor*) release indicates a minimum feature set. Changing Y means
+- a Y (**minor**) release indicates a minimum feature set. Changing Y means
  the addition of a backwards-compatible feature.
 
-- a Z (*patch*) release indicates minimum set of bugfixes. Changing
+- a Z (**patch**) release indicates minimum set of bugfixes. Changing
  Z means a backwards-compatible change that doesn't add functionality.
 
 *NB*: If the major release is `0`, any minor release may contain breaking
 changes.
 
 These guarantees extend to all code exposed in public APIs of
 IP Address Manager. This includes code both in IP Address Manager
-Baremetal itself, *plus types from dependencies in public APIs*.  Types and
+Baremetal itself, _plus types from dependencies in public APIs_. Types and
 functions not in public APIs are not considered part of the guarantee.
 
 In order to easily maintain the guarantees, we have a couple of processes
 that we follow.
 
 ## Branches
 
-IP Address Manager contains two types of branches: the *main*
-branch and *release-X* branches.
+IP Address Manager contains two types of branches: the _main_
+branch and _release-X_ branches.
 
-The *main* branch is where development happens.  All the latest and
+The _main_ branch is where development happens. All the latest and
 greatest code, including breaking changes, happen on main.
 
-The *release-X* branches contain stable, backwards compatible code.  Every
-major (X) release, a new such branch is created.  It is from these
-branches that minor and patch releases are tagged.  In some cases, it may
+The _release-X_ branches contain stable, backwards compatible code. Every
+major (X) release, a new such branch is created. It is from these
+branches that minor and patch releases are tagged. In some cases, it may
 be necessary to open PRs for bugfixes directly against stable branches, but
 this should generally be avoided.
 
@@ -98,12 +98,12 @@ for a command reference.
 Minor and patch releases are generally done immediately after a feature or
 bugfix is landed, or sometimes a series of features tied together.
 
-Minor releases will only be tagged on the *most recent* major release
+Minor releases will only be tagged on the _most recent_ major release
 branch, except in exceptional circumstances. Patches will be backported
 to maintained stable versions, as needed.
 
 Major releases are done shortly after a breaking change is merged -- once
-a breaking change is merged, the next release *must* be a major revision.
+a breaking change is merged, the next release _must_ be a major revision.
 We don't intend to have a lot of these, so we may put off merging breaking
 PRs until a later date.
 

hack/markdownlint.sh

@@ -5,15 +5,15 @@ set -eux
 IS_CONTAINER="${IS_CONTAINER:-false}"
 CONTAINER_RUNTIME="${CONTAINER_RUNTIME:-podman}"
 
+# all md files, but ignore .github
 if [ "${IS_CONTAINER}" != "false" ]; then
- TOP_DIR="${1:-.}"
- find "${TOP_DIR}" -type d \( -path ./vendor -o -path ./.github \) -prune -o -name '*.md' -exec mdl --style all --warnings {} \+
+ markdownlint-cli2 "**/*.md" "#.github"
 else
  "${CONTAINER_RUNTIME}" run --rm \
  --env IS_CONTAINER=TRUE \
  --volume "${PWD}:/workdir:ro,z" \
  --entrypoint sh \
  --workdir /workdir \
- docker.io/pipelinecomponents/markdownlint:0.13.0@sha256:9c0cdfb64fd3f1d3bdc5181629b39c2e43b6a52fc9fdc146611e1860845bbae0 \
+ docker.io/pipelinecomponents/markdownlint-cli2:0.8.1@sha256:7f85faca10c33e9104e0e461c2a1d59a997a52b22358548dd7975498c8311928 \
  /workdir/hack/markdownlint.sh "$@"
 fi

test/fuzz/README.md

@@ -21,19 +21,19 @@
 
  b. Run below command to make C binary files for the same function.
 
- ```
+ ```console
  clang -o yaml_FuzzNewIPPoolManager  yaml_FuzzNewIPPoolManager.a -fsanitize=fuzzer
  ```
 
  c. Run the fuzzer as below
 
- ```
+ ```console
  ./yaml_FuzzNewIPPoolManager
  ```
 
 - Execution: Here is an example for execution of some test outputs:
 
- ```
+ ```console
  [63 32 45 58 119 50 9 119 50 9 119 50 9 45 58
  50 9 119 9 119 50 9 91 13 45 58]
  &{TypeMeta:{Kind: APIVersion:}