Convert site to markdown

Build with m-site-p This closes #152
eclipse-sisu · Aug 30, 2024 · 6f603b3 · 6f603b3
1 parent b848262
commit 6f603b3
Show file tree

Hide file tree

Showing 19 changed files with 924 additions and 47 deletions.
diff --git a/docs/assets/img/sisu.png b/docs/assets/img/sisu.png
diff --git a/org.eclipse.sisu.inject.extender/pom.xml b/org.eclipse.sisu.inject.extender/pom.xml
@@ -25,7 +25,8 @@
 
   <artifactId>org.eclipse.sisu.inject.extender</artifactId>
   <packaging>jar</packaging>
-  <description>JSR330-based container; supports classpath scanning, auto-binding, and dynamic auto-wiring</description>
+  <name>Eclipse Sisu JSR 330 Extender</name>
+  <description>Automatically discovers and wires JSR 330 components contained in OSGi bundles</description>
 
   <build>
     <resources>

diff --git a/org.eclipse.sisu.inject/pom.xml b/org.eclipse.sisu.inject/pom.xml
@@ -25,6 +25,7 @@
 
   <artifactId>org.eclipse.sisu.inject</artifactId>
   <packaging>jar</packaging>
+  <name>Eclipse Sisu Container</name>
   <description>JSR330-based container; supports classpath scanning, auto-binding, and dynamic auto-wiring</description>
 
   <dependencies>

diff --git a/org.eclipse.sisu.inject/src/site/markdown/named-index.md b/org.eclipse.sisu.inject/src/site/markdown/named-index.md
@@ -0,0 +1,6 @@
+# Generation of Named Index
+
+Often Sisu's `SpaceModule` doesn't scan the full classpath at run time (for relevant annotations) but relies on a pre-generated index at `META-INF/sisu/javax.inject.Named`. There are two different ways how to create such an index file:
+
+1. By leveraging the Java annotation processor in [`org.eclipse.sisu.space.SisuIndexAPT6`](https://github.com/eclipse-sisu/sisu-project/blob/main/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors).
+2. By leveraging the dedicated [Maven plugin](../sisu-maven-plugin/index.html)
diff --git a/org.eclipse.sisu.inject/src/site/site.xml b/org.eclipse.sisu.inject/src/site/site.xml
@@ -0,0 +1,19 @@
+<!--
+
+    All rights reserved. This program and the accompanying materials
+    are made available under the terms of the Eclipse Public License 2.0
+    which accompanies this distribution, and is available at
+    https://www.eclipse.org/legal/epl-2.0/
+
+    SPDX-License-Identifier: EPL-2.0
+
+-->
+<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
+  <body>
+    <menu name="Overview">
+      <item name="Introduction" href="index.html"/>
+      <item name="Named Index" href="named-index.html"/>
+    </menu>
+  </body>
+</site>
diff --git a/org.eclipse.sisu.mojos/pom.xml b/org.eclipse.sisu.mojos/pom.xml
@@ -25,7 +25,8 @@
 
   <artifactId>sisu-maven-plugin</artifactId>
   <packaging>maven-plugin</packaging>
-  <description>Manage Sisu components and applications</description>
+  <name>Eclipse Sisu Maven Plugin</name>
+  <description>Maven plugin generating Sisu index files</description>
 
   <prerequisites>
     <maven>${mavenRuntimeVersion}</maven>
@@ -129,7 +130,7 @@
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-plugin-plugin</artifactId>
+        <artifactId>maven-plugin-report-plugin</artifactId>
       </plugin>
     </plugins>
   </reporting>

diff --git a/org.eclipse.sisu.mojos/src/site/markdown/index.md b/org.eclipse.sisu.mojos/src/site/markdown/index.md
@@ -1,18 +1,10 @@
-title: Sisu Plugin for Maven
-author: Stuart McCulloch
-date: 2011-03-10
-
-## Introduction
-
+# Introduction
 
  The Sisu Plugin for Maven provides mojos to generate `META-INF/sisu/javax.inject.Named` index files for the [Sisu container](http://eclipse.org/sisu/).
 
+# Usage
 
-
-## Usage
-
-
-### Indexing individual projects
+## Indexing individual projects
 
 
 
@@ -40,10 +32,7 @@ date: 2011-03-10
 </project>
 ```
 
-
-### Indexing assembled applications
-
-
+## Indexing assembled applications
 
 ```
 <project>
@@ -71,5 +60,3 @@ date: 2011-03-10
   [...]
 </project>
 ```
-
-
diff --git a/org.eclipse.sisu.mojos/src/site/site.xml b/org.eclipse.sisu.mojos/src/site/site.xml
@@ -12,12 +12,10 @@
       Stuart McCulloch (Sonatype, Inc.) - initial API and implementation
 
 -->
-<project name="${project.name}">
-  <publishDate position="left"/>
-  <version position="left"/>
+<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
   <body>
     <links>
-      <item name="Sisu" href="http://eclipse.org/sisu/"/>
       <item name="Maven" href="http://maven.apache.org/"/>
     </links>
     <menu name="Overview">
@@ -26,16 +24,4 @@
     </menu>
     <menu ref="reports"/>
   </body>
-  <skin>
-    <groupId>org.apache.maven.skins</groupId>
-    <artifactId>maven-fluido-skin</artifactId>
-    <version>1.9</version>
-  </skin>
-  <custom>
-    <fluidoSkin>
-      <topBarEnabled>true</topBarEnabled>
-      <sideBarEnabled>false</sideBarEnabled>
-    </fluidoSkin>
-  </custom>
-</project>
-
+</site>
diff --git a/org.eclipse.sisu.plexus/pom.xml b/org.eclipse.sisu.plexus/pom.xml
@@ -25,6 +25,7 @@
 
   <artifactId>org.eclipse.sisu.plexus</artifactId>
   <packaging>jar</packaging>
+  <name>Eclipse Sisu Plexus</name>
   <description>Plexus-JSR330 adapter; adds Plexus support to the Sisu-Inject container</description>
 
   <dependencies>