Documentation for porting Kettle plugins: add Jandex information
@@ -46,6 +46,50 @@ Hop doesn't publish artifacts to Maven Central (yet). You need to include the Ap
</repositories>
----
+== Jandex
+
+To speed up searching for plugin annotations Apache Hop uses a Java Annotations Index: Jandex. Unless you have such an index in your plugin JAR file Hop will not pick it up.
+To add the index you simply need to add the plugin to your maven pom.xml:
+
+[source, xml]
+----
+...
+<properties>
+ <jandex-maven-plugin.version>1.0.8</jandex-maven-plugin.version>
+</properties>
+...
+<build>
+ ...
+ <pluginManagement>
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.jboss.jandex</groupId>
+ <artifactId>jandex-maven-plugin</artifactId>
+ <version>${jandex-maven-plugin.version}</version>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+
+ <plugins>
+ ...
+ <groupId>org.jboss.jandex</groupId>
+ <artifactId>jandex-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>make-index</id>
+ <goals>
+ <goal>jandex</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugins>
+</build>
+----
+
+For more information about Jandex, please see: https://github.com/wildfly/jandex-maven-plugin/
+After the build and the Java annotations index was made you should see a file called `META-INF/jandex.idx` in your plugin JAR file.
+
== API changes
=== Interface naming
