Add missing doc files

quarkiverse · Jan 26, 2024 · 5b45943 · 5b45943
1 parent c264f56
commit 5b45943
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 2 deletions.
diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc
@@ -0,0 +1,3 @@
+:project-version: 3.1.3
+
+:examples-dir: ./../examples/
diff --git a/docs/modules/ROOT/pages/includes/quarkus-log-handler-splunk.adoc b/docs/modules/ROOT/pages/includes/quarkus-log-handler-splunk.adoc
@@ -1,6 +1,6 @@
 
 :summaryTableId: quarkus-log-handler-splunk
-[.configuration-legend]
+[.configuration-legend]
 icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
 [.configuration-reference.searchable, cols="80,.^10,.^10"]
 |===

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -20,6 +20,7 @@ In your `pom.xml` file, add:
 <dependency>
     <groupId>io.quarkiverse.logging.splunk</groupId>
     <artifactId>quarkus-logging-splunk</artifactId>
+    <version>{project-version}</version>
 </dependency>
 ----
 

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -26,6 +26,23 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>it.ozimov</groupId>
+        <artifactId>yaml-properties-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <phase>initialize</phase>
+            <goals>
+              <goal>read-project-properties</goal>
+            </goals>
+            <configuration>
+              <files>
+                <file>${project.basedir}/../.github/project.yml</file>
+              </files>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <artifactId>maven-resources-plugin</artifactId>
         <executions>
@@ -44,10 +61,31 @@
                   <include>quarkus-log-handler-splunk.adoc</include>
                   <filtering>false</filtering>
                 </resource>
+                <resource>
+                  <directory>${project.basedir}/templates/includes</directory>
+                  <include>attributes.adoc</include>
+                  <filtering>true</filtering>
+                </resource>
               </resources>
               <skip>${skip.config.copy}</skip>
             </configuration>
           </execution>
+          <execution>
+            <id>copy-images</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>copy-resources</goal>
+            </goals>
+            <configuration>
+              <outputDirectory>${project.build.directory}/generated-docs/_images/</outputDirectory>
+              <resources>
+                <resource>
+                  <directory>${project.basedir}/modules/ROOT/assets/images/</directory>
+                  <filtering>false</filtering>
+                </resource>
+              </resources>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
       <plugin>
@@ -78,4 +116,4 @@
       </properties>
     </profile>
   </profiles>
-</project>
+</project>
diff --git a/docs/templates/includes/attributes.adoc b/docs/templates/includes/attributes.adoc
@@ -0,0 +1,3 @@
+:project-version: ${release.current-version}
+
+:examples-dir: ./../examples/
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		:project-version: 3.1.3

		:examples-dir: ./../examples/
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		:project-version: ${release.current-version}

		:examples-dir: ./../examples/