Skip to content

Commit cccc62d

Browse files
garydgregorygarydgregory
committed
Migrate site generation templates to
https://maven.apache.org/xsd/xdoc-2.0.xsd
1 parent 0bf53b5 commit cccc62d

File tree

7 files changed

+43
-42
lines changed

7 files changed

+43
-42
lines changed

‎src/changes/changes.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<body>
2727
<release version="1.9.1" date="YYYY-MM-DD" description="Version 1.9.1.">
2828
<!-- FIX -->
29+
<action dev="ggregory" type="fix" due-to="Gary Gregory">Migrate site generation templates to https://maven.apache.org/xsd/xdoc-2.0.xsd.</action>
2930
<!-- ADD -->
3031
<!-- UPDATE -->
3132
<action type="update" dev="engelen" due-to="Dependabot, Arnout Engelen">Bump org.apache.commons:commons-build-plugin from 1.14.1 to 1.15.0 #355.</action>

‎src/site/xdoc/development.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@
1313
See the License for the specific language governing permissions and
1414
limitations under the License.
1515
-->
16-
<document>
17-
16+
<document xmlns="http://maven.apache.org/XDOC/2.0"
17+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
18+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
1819
<properties>
1920
<title>Development</title>
2021
<author email="[email protected]">Apache Commons Documentation Team</author>

‎src/site/xdoc/download_release-plugin.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ limitations under the License.
5656
| |
5757
+======================================================================+
5858
-->
59-
<document>
59+
<document xmlns="http://maven.apache.org/XDOC/2.0"
60+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
61+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
6062
<properties>
6163
<title>Download Apache Commons Release Plugin</title>
6264
<author email="[email protected]">Apache Commons Documentation Team</author>

‎src/site/xdoc/index.xml‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
19-
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
2021
<properties>
2122
<title>Overview</title>
2223
<author email="[email protected]">Apache Commons Team</author>
@@ -49,6 +50,7 @@
4950
<p>
5051
Available Goals (which are meant to be used together; the only reason they are separated is for
5152
code readability):
53+
</p>
5254
<ul>
5355
<li>
5456
<b>commons-release:detach-distributions</b> - Remove
@@ -65,7 +67,6 @@
6567
<a href="vote-txt.html">commons-release:vote-txt</a> -Dcommons.nexus.repo.id=nnnn [-Dgit.tag.name] # where nnn is the number following orgapachecommons- in the Nexus 'Repository' column
6668
</li>
6769
</ul>
68-
</p>
6970
</section>
7071

7172
<section name="Using the plugin">
@@ -143,27 +144,27 @@
143144
After the above configuration performing the release would occur by (<i>note.</i> more
144145
in depth details can be found at
145146
<a href="https://commons.apache.org/releases/prepare.html">Preparations For A Release</a>):
146-
<ol>
147-
<li>creating our release branch,</li>
148-
<li>checking compatibility,</li>
149-
<li>checking your dependencies,</li>
150-
<li>checking javadocs and code style,</li>
151-
<li>checking the apache license,</li>
152-
<li>configure the build to generate a complete set of release artifacts,</li>
153-
<li>preparing the release notes, updating the download file and other autogenerated files,</li>
154-
<li>tagging the release candidate, and</li>
155-
<li>
147+
</p>
148+
<ol>
149+
<li>creating our release branch,</li>
150+
<li>checking compatibility,</li>
151+
<li>checking your dependencies,</li>
152+
<li>checking javadocs and code style,</li>
153+
<li>checking the apache license,</li>
154+
<li>configure the build to generate a complete set of release artifacts,</li>
155+
<li>preparing the release notes, updating the download file and other autogenerated files,</li>
156+
<li>tagging the release candidate, and</li>
157+
<li>
156158
running the following command:
157159
<source><![CDATA[
158160
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword] [-Dcommons.release.dryRun=true -Ptest-deploy] -Prelease clean test site deploy
159-
]]></source>
160-
</li>
161-
</ol>
161+
]]></source></li>
162+
</ol>
163+
<p>
162164
To avoid specifying distribution credentials at the command
163165
line, consider using the <code>distServer</code> plugin configuration parameter (property <code>commons.distServer</code>)
164166
to specify a server definition in Maven <code>settings.xml</code> which defines your (encrypted, right?) authentication info.
165167
</p>
166-
167168
<p>
168169
If the component is new, then, before running this maven command, you would want to create
169170
the requisite subversion directory <code>https://dist.apache.org/repos/dist/dev/commons/foo</code>. Notice,

‎src/site/xdoc/issue-tracking.xml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ limitations under the License.
4141
| |
4242
+======================================================================+
4343
-->
44-
<document>
44+
<document xmlns="http://maven.apache.org/XDOC/2.0"
45+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
46+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
4547
<properties>
4648
<title>Apache Commons Release Plugin Issue tracking</title>
4749
<author email="[email protected]">Apache Commons Documentation Team</author>
@@ -64,6 +66,7 @@ limitations under the License.
6466
<p>
6567
If you would like to report a bug, or raise an enhancement request with
6668
Apache Commons Release Plugin please do the following:
69+
</p>
6770
<ol>
6871
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">Search existing open bugs</a>.
6972
If you find your issue listed then please add a comment with your details.</li>
@@ -73,16 +76,15 @@ limitations under the License.
7376
<li>Submit either a <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&amp;component=12312401&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug report</a>
7477
or <a href="https://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310466&amp;component=12312401&amp;issuetype=4&amp;priority=4&amp;assignee=-1">enhancement request</a>.</li>
7578
</ol>
76-
</p>
7779

7880
<p>
7981
Please also remember these points:
82+
</p>
8083
<ul>
8184
<li>the more information you provide, the better we can help you</li>
8285
<li>test cases are vital, particularly for any proposed enhancements</li>
8386
<li>the developers of Apache Commons Release Plugin are all unpaid volunteers</li>
8487
</ul>
85-
</p>
8688

8789
<p>
8890
For more information on creating patches see the
@@ -91,12 +93,12 @@ limitations under the License.
9193

9294
<p>
9395
You may also find these links useful:
96+
</p>
9497
<ul>
9598
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All Open Apache Commons Release Plugin bugs</a></li>
9699
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All Resolved Apache Commons Release Plugin bugs</a></li>
97100
<li><a href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310466&amp;component=12312401&amp;sorter/field=issuekey&amp;sorter/order=DESC">All Apache Commons Release Plugin bugs</a></li>
98101
</ul>
99-
</p>
100102
</section>
101103
</body>
102104
</document>

‎src/site/xdoc/mail-lists.xml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ limitations under the License.
3939
| |
4040
+======================================================================+
4141
-->
42-
<document>
42+
<document xmlns="http://maven.apache.org/XDOC/2.0"
43+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
4345
<properties>
4446
<title>Apache Commons Release Plugin Mailing Lists</title>
4547
<author email="[email protected]">Apache Commons Documentation Team</author>
@@ -53,10 +55,10 @@ limitations under the License.
5355
To make it easier for people to only read messages related to components they are interested in,
5456
the convention in Commons is to prefix the subject line of messages with the component's name,
5557
for example:
56-
<ul>
57-
<li>[release-plugin] Problem with the ...</li>
58-
</ul>
5958
</p>
59+
<ul>
60+
<li>[release-plugin] Problem with the ...</li>
61+
</ul>
6062
<p>
6163
Questions related to the usage of Apache Commons Release Plugin should be posted to the
6264
<a href="https://lists.apache.org/[email protected]">User List</a>.

‎src/site/xdoc/vote-txt.xml‎

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,26 @@
1515
See the License for the specific language governing permissions and
1616
limitations under the License.
1717
-->
18-
<document>
19-
18+
<document xmlns="http://maven.apache.org/XDOC/2.0"
19+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20+
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
2021
<properties>
2122
<title>Generating VOTE.txt</title>
2223
<author email="[email protected]">Apache Commons Documentation Team</author>
2324
</properties>
24-
2525
<body>
26-
27-
28-
<section name="commons-release:vote-txt" href="vote-txt">
29-
26+
<section name="commons-release:vote-txt" id="vote-txt">
3027
<subsection name="Overview">
3128
<p>
3229
The <code>commons-release:vote-txt</code> goal generates a VOTE.txt file for a component.
3330
Execute the goal using the following command: <source>mvn commons-release:vote-txt</source>
3431
</p>
35-
3632
<p>
3733
<strong>Note:</strong> The VOTE.txt should be regenerated before every release candidate.
3834
</p>
39-
4035
<p>
4136
This goal uses the following:
37+
</p>
4238
<ul>
4339
<li>The goal is mapped to the ant script/target using the <code>vote-txt</code> mojo definition in the
4440
<a href="http://svn.apache.org/repos/asf/commons/proper/commons-release-plugin/trunk/src/main/scripts/generate-xdocs.mojos.xml">generate-xdocs.mojos.xml</a> mapping document</li>
@@ -49,17 +45,15 @@
4945
template</li>
5046
<li>Uses the <a href="vote-txt-mojo.html">goal's (i.e. mojo's) parameters</a> to filter values in the template</li>
5147
</ul>
52-
</p>
5348
</subsection>
54-
5549
<subsection name="Configuration">
5650
<p>
5751
To generate a VOTE.txt, the following <a href="vote-txt-mojo.html">properties</a> are configured in the component's <code>pom.xml</code>
52+
</p>
5853
<ul>
5954
<li><b>commons.componentid</b> - Commons component ID</li>
6055
<li><b>commons.release.version</b> - The version number of the latest release of the component</li>
6156
</ul>
62-
</p>
6357
<p>
6458
Example configuration for Commons Chain:
6559
<source><![CDATA[
@@ -70,8 +64,6 @@
7064
]]></source>
7165
</p>
7266
</subsection>
73-
7467
</section>
75-
7668
</body>
7769
</document>

0 commit comments

Comments
 (0)