Skip to content

Commit f46f6cc

Browse files
committed
Convert the remaining xdoc pages to Markdown
get-involved and ref/available-components, converted with doxia-converter. The YAML front matter is kept: it carries each page's title and author, which the skin turns into <title> and <meta name="author">. 404.xml stays xdoc on purpose. It carries a <head> block with a <base href> and absolute stylesheet links, and Markdown front matter can only produce <title> and <meta>; a 404 page is served from arbitrary URLs, so the <base> cannot be dropped. Verified by rendering the site before and after: both pages are identical in title, author, visible text and every link target. Generated-by: Claude Opus 5 (1M context)
1 parent 0ffa2e4 commit f46f6cc

2 files changed

Lines changed: 62 additions & 118 deletions

File tree

src/site/markdown/get-involved.md

Lines changed: 46 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
---
2+
title: Getting Involved
3+
author:
4+
- Rahul Thakur
5+
- Olivier Lamy
6+
---
7+
28
<!--
39
Licensed to the Apache Software Foundation (ASF) under one
410
or more contributor license agreements. See the NOTICE file
@@ -17,86 +23,42 @@ KIND, either express or implied. See the License for the
1723
specific language governing permissions and limitations
1824
under the License.
1925
-->
20-
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21-
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
22-
<properties>
23-
<title>Getting Involved</title>
24-
<author>Rahul Thakur</author>
25-
<author>Olivier Lamy</author>
26-
</properties>
27-
28-
<body>
29-
<section name="Getting Involved">
30-
31-
<p>
32-
Contributions are welcome. The full guide lives with the code:
33-
<a href="https://github.com/codehaus-plexus/.github/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.
34-
The short version is below.
35-
</p>
36-
37-
<subsection name="Where to ask">
38-
<p>
39-
<a href="https://github.com/codehaus-plexus">GitHub issues</a>, on the repository concerned.
40-
That is where the maintainers are. There is no Plexus mailing list — if you find one referenced
41-
in older documentation on this site, it is defunct.
42-
</p>
43-
<p>
44-
Each project on the <a href="./index.html">overview page</a> links to its own repository. If you
45-
aren't sure which one owns the behaviour you're seeing, open the issue wherever seems closest
46-
and we'll move it.
47-
</p>
48-
</subsection>
49-
50-
<subsection name="Building">
51-
<p>
52-
<code>mvn verify</code>. No profile or local setup is required. CI builds across JDK 8, 21 and 25
53-
on Linux, Windows and macOS.
54-
</p>
55-
</subsection>
56-
57-
<subsection name="Code style">
58-
<p>
59-
Formatting is enforced by the build, via
60-
<a href="https://github.com/diffplug/spotless">Spotless</a> and
61-
<a href="https://github.com/palantir/palantir-java-format">palantir-java-format</a>. Don't hand-format,
62-
and don't reformat code you aren't otherwise touching. Before pushing:
63-
</p>
64-
<source>mvn spotless:apply</source>
65-
<p>
66-
If CI fails on <code>spotless:check</code>, running that command and committing the result is the
67-
whole fix.
68-
</p>
69-
<p>
70-
This page previously offered <code>maven-eclipse-codestyle.xml</code> and
71-
<code>maven-idea-codestyle.xml</code> for import into your IDE. Those predate Spotless and no longer
72-
match what the build enforces, so they are no longer linked from here. The files themselves are still
73-
served, so any existing link to them keeps working.
74-
</p>
75-
</subsection>
76-
77-
<subsection name="Licence headers">
78-
<p>
79-
New files take the standard header used by the files around them — Apache-2.0 for everything except
80-
Modello, which is MIT. Please do not update or normalise existing copyright headers, including the
81-
older Codehaus Foundation ones; they record who contributed what.
82-
</p>
83-
</subsection>
84-
85-
<subsection name="Pull requests">
86-
<p>
87-
One concern per pull request, a test where the change is testable, and an explanation of <i>why</i> in
88-
the description. These libraries are consumed transitively across most of the Maven plugin ecosystem,
89-
so changes to public API need discussion in an issue first — deprecate rather than remove.
90-
</p>
91-
</subsection>
92-
93-
<subsection name="Security">
94-
<p>
95-
Please do not open a public issue for a vulnerability. See
96-
<a href="https://github.com/codehaus-plexus/.github/blob/master/SECURITY.md">SECURITY.md</a>.
97-
</p>
98-
</subsection>
99-
100-
</section>
101-
</body>
102-
</document>
26+
27+
# Getting Involved
28+
29+
Contributions are welcome. The full guide lives with the code: [CONTRIBUTING.md](https://github.com/codehaus-plexus/.github/blob/master/CONTRIBUTING.md). The short version is below.
30+
31+
## Where to ask
32+
33+
[GitHub issues](https://github.com/codehaus-plexus), on the repository concerned. That is where the maintainers are. There is no Plexus mailing list — if you find one referenced in older documentation on this site, it is defunct.
34+
35+
Each project on the [overview page](./index.html) links to its own repository. If you aren't sure which one owns the behaviour you're seeing, open the issue wherever seems closest and we'll move it.
36+
37+
## Building
38+
39+
`mvn verify`. No profile or local setup is required. CI builds across JDK 8, 21 and 25 on Linux, Windows and macOS.
40+
41+
## Code style
42+
43+
Formatting is enforced by the build, via [Spotless](https://github.com/diffplug/spotless) and [palantir-java-format](https://github.com/palantir/palantir-java-format). Don't hand-format, and don't reformat code you aren't otherwise touching. Before pushing:
44+
45+
```unknown
46+
mvn spotless:apply
47+
```
48+
49+
If CI fails on `spotless:check`, running that command and committing the result is the whole fix.
50+
51+
This page previously offered `maven-eclipse-codestyle.xml` and `maven-idea-codestyle.xml` for import into your IDE. Those predate Spotless and no longer match what the build enforces, so they are no longer linked from here. The files themselves are still served, so any existing link to them keeps working.
52+
53+
## Licence headers
54+
55+
New files take the standard header used by the files around them — Apache-2.0 for everything except Modello, which is MIT. Please do not update or normalise existing copyright headers, including the older Codehaus Foundation ones; they record who contributed what.
56+
57+
## Pull requests
58+
59+
One concern per pull request, a test where the change is testable, and an explanation of _why_ in the description. These libraries are consumed transitively across most of the Maven plugin ecosystem, so changes to public API need discussion in an issue first — deprecate rather than remove.
60+
61+
## Security
62+
63+
Please do not open a public issue for a vulnerability. See [SECURITY.md](https://github.com/codehaus-plexus/.github/blob/master/SECURITY.md).
64+
Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
---
2+
title: Available Plexus Components
3+
author:
4+
- Rahul Thakur
5+
- Olivier Lamy
6+
---
7+
28
<!--
39
Licensed to the Apache Software Foundation (ASF) under one
410
or more contributor license agreements. See the NOTICE file
@@ -17,36 +23,12 @@ KIND, either express or implied. See the License for the
1723
specific language governing permissions and limitations
1824
under the License.
1925
-->
20-
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21-
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
22-
<properties>
23-
<title>Available Plexus Components</title>
24-
<author>Rahul Thakur</author>
25-
<author>Olivier Lamy</author>
26-
</properties>
27-
28-
<body>
29-
<section name="Available Plexus Components">
30-
31-
<p>
32-
<b>This page is out of date and is kept only so existing links to it keep working.</b>
33-
</p>
34-
35-
<p>
36-
The current list of Plexus libraries and components, with links to their sites, is on the
37-
<a href="../index.html">overview page</a>.
38-
</p>
39-
40-
<p>
41-
The list that used to be here described the components as they stood when Plexus was still an
42-
IoC container. Most of what it advertised no longer exists in any form — <code>plexus-cli</code>,
43-
<code>plexus-spring</code>, <code>plexus-contextualizer</code>, <code>plexus-xwork-integration</code>,
44-
<code>plexus-mail-sender</code>, <code>plexus-cache</code> and <code>plexus-swizzle</code> are all
45-
gone or archived — and it listed none of the components that are actually maintained today.
46-
Rather than leave that standing, the content has been removed and the overview page is now the
47-
single index.
48-
</p>
49-
50-
</section>
51-
</body>
52-
</document>
26+
27+
# Available Plexus Components
28+
29+
**This page is out of date and is kept only so existing links to it keep working.**
30+
31+
The current list of Plexus libraries and components, with links to their sites, is on the [overview page](../index.html).
32+
33+
The list that used to be here described the components as they stood when Plexus was still an IoC container. Most of what it advertised no longer exists in any form — `plexus-cli`, `plexus-spring`, `plexus-contextualizer`, `plexus-xwork-integration`, `plexus-mail-sender`, `plexus-cache` and `plexus-swizzle` are all gone or archived — and it listed none of the components that are actually maintained today. Rather than leave that standing, the content has been removed and the overview page is now the single index.
34+

0 commit comments

Comments
 (0)