wip

Signed-off-by: Attila Mészáros <[email protected]>

Author: csviri

operator-framework/pom.xml

@@ -86,7 +86,7 @@
     </dependency>
     <dependency>
       <groupId>io.javaoperatorsdk</groupId>
-      <artifactId>sample-index-processor</artifactId>
+      <artifactId>test-index-processor</artifactId>
       <version>${project.version}</version>
       <scope>test</scope>
       <optional>true</optional>
@@ -124,7 +124,7 @@
               <annotationProcessorPaths>
                 <path>
                   <groupId>io.javaoperatorsdk</groupId>
-                  <artifactId>sample-index-processor</artifactId>
+                  <artifactId>test-index-processor</artifactId>
                   <version>${project.version}</version>
                 </path>
               </annotationProcessorPaths>

pom.xml

@@ -36,7 +36,7 @@
     <module>sample-operators</module>
     <module>caffeine-bounded-cache-support</module>
     <module>bootstrapper-maven-plugin</module>
-    <module>sample-index-processor</module>
+    <module>test-index-processor</module>
   </modules>
 
   <scm>

sample-index-processor/pom.xml renamed to test-index-processor/pom.xml

@@ -8,9 +8,9 @@
     <version>5.1.6-SNAPSHOT</version>
   </parent>
 
-  <artifactId>sample-index-processor</artifactId>
-  <name>Sample Index Annotation Processor</name>
-  <description>Annotation processor for generating integration test sample documentation</description>
+  <artifactId>test-index-processor</artifactId>
+  <name>Test Index Annotation Processor</name>
+  <description>Annotation processor for generating integration test index documentation</description>
 
   <dependencies>
     <!-- No dependencies needed for a simple annotation processor -->

sample-index-processor/src/main/java/io/javaoperatorsdk/annotation/Sample.java renamed to test-index-processor/src/main/java/io/javaoperatorsdk/annotation/Sample.java

@@ -72,11 +72,13 @@ private void generateMarkdownFile() {
 
       try (BufferedWriter writer = new BufferedWriter(file.openWriter())) {
         writer.write("---\n");
-        writer.write("title: Test Index\n");
+        writer.write("title: Integration Test Index\n");
         writer.write("weight: 105\n");
         writer.write("---\n\n");
         writer.write(
-            "This document provides an index of all integration tests annotated with @Sample.\n\n");
+            "This document provides an index of all integration tests annotated with @Sample.\n\n"
+                + "These server also as sample for various use cases. "
+                + "Your are encouraged to both the tests and descriptions.\n\n");
 
         // Generate table of contents
         writer.write("## Contents\n\n");