From 98a002f26f311f02956d3b8511f9ade00237b1c0 Mon Sep 17 00:00:00 2001
From: Andrzej Jarmoniuk <gh@jarmoniuk.nl>
Date: Sun, 23 Oct 2022 15:22:33 +0200
Subject: [PATCH] #725: Migrate Recording Changes to Markdown

---
 src/site/apt/examples/recording-changes.apt   | 49 -------------------
 .../markdown/examples/recording-changes.md    | 44 +++++++++++++++++
 2 files changed, 44 insertions(+), 49 deletions(-)
 delete mode 100644 src/site/apt/examples/recording-changes.apt
 create mode 100644 src/site/markdown/examples/recording-changes.md

diff --git a/src/site/apt/examples/recording-changes.apt b/src/site/apt/examples/recording-changes.apt
deleted file mode 100644
index a7b559476..000000000
--- a/src/site/apt/examples/recording-changes.apt
+++ /dev/null
@@ -1,49 +0,0 @@
- ~~ Licensed to the Apache Software Foundation (ASF) under one
- ~~ or more contributor license agreements.  See the NOTICE file
- ~~ distributed with this work for additional information
- ~~ regarding copyright ownership.  The ASF licenses this file
- ~~ to you under the Apache License, Version 2.0 (the
- ~~ "License"); you may not use this file except in compliance
- ~~ with the License.  You may obtain a copy of the License at
- ~~
- ~~   http://www.apache.org/licenses/LICENSE-2.0
- ~~
- ~~ Unless required by applicable law or agreed to in writing,
- ~~ software distributed under the License is distributed on an
- ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~~ KIND, either express or implied.  See the License for the
- ~~ specific language governing permissions and limitations
- ~~ under the License.
-
- -----
- Recording Changes
- -----
- Mark Raynsford
- ------
- 2020-06-27
- ------
-
-Recording Changes
-
-  Here's an example:
-
----
-mvn versions:use-latest-releases -DchangeRecorderFormat=xml
----
-
-  Which writes a file to <<<target/versions-changes.xml>>> that looks something
-  like:
-
----
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<updates xmlns="http://www.mojohaus.org/versions-maven-plugin/schema/updates/1.0">
-  <update artifactId="dummy-api"
-          groupId="localhost"
-          kind="useLatestReleases"
-          newVersion="3.0"
-          oldVersion="1.1.1-2"/>
-</updates>
----
-
-  The contents of this file records the fact that <<<localhost:dummy-api:1.1.1-2>>>
-  was upgraded to <<<3.0>>>.
diff --git a/src/site/markdown/examples/recording-changes.md b/src/site/markdown/examples/recording-changes.md
new file mode 100644
index 000000000..9497d8248
--- /dev/null
+++ b/src/site/markdown/examples/recording-changes.md
@@ -0,0 +1,44 @@
+title: Recording Changes
+author: Mark Raynsford
+date: 2020-06-27
+
+<!---
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+  https://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# Recording Changes
+
+Here's an example:
+
+```sh
+mvn versions:use-latest-releases -DchangeRecorderFormat=xml
+```
+
+Which writes a file to `target/versions-changes.xml` that looks something like:
+
+```xml
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<updates xmlns="http://www.mojohaus.org/versions-maven-plugin/schema/updates/1.0">
+  <update artifactId="dummy-api"
+          groupId="localhost"
+          kind="useLatestReleases"
+          newVersion="3.0"
+          oldVersion="1.1.1-2"/>
+</updates>
+```
+
+The contents of this file records the fact that `localhost:dummy-api:1.1.1-2`
+was upgraded to `3.0`.