Port from Doxia 1 to 2

apache · Jan 24, 2025 · e01a741 · e01a741
1 parent c3b3866
commit e01a741
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 22 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,7 +6,7 @@
  (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
+      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,
@@ -41,9 +41,8 @@
 Contributing to Apache Commons Configuration
 ======================
 
-You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
-the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
-follow so that we can have a chance of keeping on top of things.
+Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
+Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.
 
 Getting Started
 ---------------
@@ -62,7 +61,7 @@ Making Changes
 
 + Create a _topic branch_ for your isolated work.
   * Usually you should base your branch on the `master` branch.
-  * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `CONFIGURATION-123-InputStream`.
+  * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CONFIGURATION-123-InputStream`.
   * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
 + Make commits of logical units.
   * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
@@ -72,7 +71,7 @@ Making Changes
   + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first.
   + Check for unnecessary whitespace with `git diff` -- check before committing.
 + Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
-+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
++ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.
 
 Making Trivial Changes
 ----------------------

diff --git a/src/site/xdoc/download_configuration.xml b/src/site/xdoc/download_configuration.xml
@@ -7,7 +7,7 @@ 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
+     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,
@@ -56,10 +56,12 @@ limitations under the License.
  |                                                                      |
  +======================================================================+
 -->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
   <properties>
     <title>Download Apache Commons Configuration</title>
-    <author email="[email protected]">Apache Commons Documentation Team</author>
+    <author email="[email protected]">Apache Commons Team</author>
   </properties>
   <body>
     <section name="Download Apache Commons Configuration">
@@ -79,7 +81,7 @@ limitations under the License.
         mirrors (at the end of the mirrors list) that should be
         available.
         <br></br>
-        [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
+        [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0" alt="Logo"></img></a>[end]
       </p>
 
       <form action="[location]" method="get" id="SelectMirror">

diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
@@ -7,7 +7,7 @@ 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
+     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,
@@ -41,10 +41,12 @@ limitations under the License.
  |                                                                      |
  +======================================================================+
 -->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
   <properties>
     <title>Apache Commons Configuration Issue tracking</title>
-    <author email="[email protected]">Apache Commons Documentation Team</author>
+    <author email="[email protected]">Apache Commons Team</author>
   </properties>
   <body>
 
@@ -64,6 +66,7 @@ limitations under the License.
       <p>
       If you would like to report a bug, or raise an enhancement request with
       Apache Commons Configuration please do the following:
+      </p>
       <ol>
         <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310467&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">Search existing open bugs</a>.
             If you find your issue listed then please add a comment with your details.</li>
@@ -73,16 +76,15 @@ limitations under the License.
         <li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug report</a>
             or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310467&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement request</a>.</li>
       </ol>
-      </p>
 
       <p>
       Please also remember these points:
+      </p>
       <ul>
         <li>the more information you provide, the better we can help you</li>
         <li>test cases are vital, particularly for any proposed enhancements</li>
         <li>the developers of Apache Commons Configuration are all unpaid volunteers</li>
       </ul>
-      </p>
 
       <p>
       For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
 
       <p>
       You may also find these links useful:
+      </p>
       <ul>
         <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310467&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open Apache Commons Configuration bugs</a></li>
         <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310467&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved Apache Commons Configuration bugs</a></li>
         <li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310467&amp;sorter/field=issuekey&amp;sorter/order=DESC">All Apache Commons Configuration bugs</a></li>
       </ul>
-      </p>
     </section>
   </body>
 </document>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
@@ -7,7 +7,7 @@ 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
+     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,
@@ -39,10 +39,12 @@ limitations under the License.
  |                                                                      |
  +======================================================================+
 -->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
   <properties>
     <title>Apache Commons Configuration Mailing Lists</title>
-    <author email="[email protected]">Apache Commons Documentation Team</author>
+    <author email="[email protected]">Apache Commons Team</author>
   </properties>
   <body>
 
@@ -53,10 +55,10 @@ limitations under the License.
         To make it easier for people to only read messages related to components they are interested in,
         the convention in Commons is to prefix the subject line of messages with the component's name,
         for example:
-        <ul>
-          <li>[configuration] Problem with the ...</li>
-        </ul>
       </p>
+      <ul>
+        <li>[configuration] Problem with the ...</li>
+      </ul>
       <p>
         Questions related to the usage of Apache Commons Configuration should be posted to the
         <a href="https://lists.apache.org/[email protected]">User List</a>.