doc: Merged plugin documentations, made configurable

Signed-off-by: Marc Nuri <[email protected]>

CHANGELOG.md

@@ -24,7 +24,8 @@ Usage:
 * Fix #167: Add CMD for wildfly based applications
 * Added Webapp Wildfly maven quickstart
 * Fix #171: OpenShift pull secret not picked up without registry auth configuration
-* Fix #171: Customized Quarkus application quick start 
+* Fix #171: Customized Quarkus application quick start
+* Fix #101: Removed Openshift specific functionality from Kubernetes Maven Plugin
 
 ### 1.0.0-alpha-2 (2020-04-24)
 * Fix #130: Updated HelmMojo documentation

kubernetes-maven-plugin/doc/pom.xml

@@ -32,7 +32,9 @@
   <properties>
     <asciidoctor-maven-plugin.version>1.6.0</asciidoctor-maven-plugin.version>
     <asciidoctorj.version>2.1.0</asciidoctorj.version>
-    <asciidoctorj-pdf.version>1.5.0-alpha.18</asciidoctorj-pdf.version>
+    <plugin>kubernetes-maven-plugin</plugin>
+    <goal-prefix>k8s</goal-prefix>
+    <cluster>Kubernetes</cluster>
   </properties>
 
   <dependencies>
@@ -148,6 +150,10 @@
                   <attributes>
                     <toc>left</toc>
                     <linkcss>false</linkcss>
+                    <plugin>${plugin}</plugin>
+                    <goal-prefix>${goal-prefix}</goal-prefix>
+                    <cluster>${cluster}</cluster>
+                    <version>${project.version}</version>
                   </attributes>
                 </configuration>
               </execution>
@@ -157,43 +163,6 @@
       </build>
       <activation><activeByDefault>true</activeByDefault></activation>
     </profile>
-
-    <!-- ==== PDF documentation ====================== -->
-
-    <profile>
-      <id>pdf</id>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.asciidoctor</groupId>
-            <artifactId>asciidoctor-maven-plugin</artifactId>
-            <executions>
-              <execution>
-                <id>output-pdf</id>
-                <phase>package</phase>
-                <goals>
-                  <goal>process-asciidoc</goal>
-                </goals>
-                <configuration>
-                  <backend>pdf</backend>
-                  <sourceHighlighter>rouge</sourceHighlighter>
-                  <attributes>
-                    <toc/>
-                  </attributes>
-                </configuration>
-              </execution>
-            </executions>
-            <dependencies>
-              <dependency>
-                <groupId>org.asciidoctor</groupId>
-                <artifactId>asciidoctorj-pdf</artifactId>
-                <version>${asciidoctorj-pdf.version}</version>
-              </dependency>
-            </dependencies>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
   </profiles>
 
 </project>

kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_access.adoc

@@ -6,7 +6,7 @@
 
 WARNING: This section is work-in-progress and not yet finished
 
-For Kubernetes builds the kubernetes-maven-plugin uses the Docker remote API so the URL of your Docker Daemon must be specified. The URL can be specified by the dockerHost or machine configuration, or by the `DOCKER_HOST` environment variable. If not given
+For {cluster} builds the {plugin} uses the Docker remote API so the URL of your Docker Daemon must be specified. The URL can be specified by the dockerHost or machine configuration, or by the `DOCKER_HOST` environment variable. If not given
 
 The Docker remote API supports communication via SSL and
 authentication with certificates.  The path to the certificates can
@@ -18,4 +18,3 @@ be specified by the certPath or machine configuration, or by the
 
 Plugin reads your `kubeconfig` file to read your Kubernetes/OpenShift configuration. By default, `kubeconfig` file is assumed to be either
 in `~/.kube/config` or using the environment variable `KUBECONFIG`.
-

kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_appendix.adoc

@@ -16,11 +16,11 @@ By default if no environment variable nor system property is set, scan for a fil
 
 * By embedding in MOJO configuration the mapping:
 
-[source, xml]
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
 ----
 <plugin>
   <groupId>org.eclipse.jkube</groupId>
-  <artifactId>kubernetes-maven-plugin</artifactId>
+  <artifactId>{plugin}</artifactId>
   <configuration>
     <mappings>
       <mapping>

kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_authentication.adoc

@@ -2,7 +2,7 @@
 [[authentication]]
 = Authentication
 
-When pulling (via the `autoPull` mode of `{plugin}:start`) or pushing image, it
+When pulling (via the `autoPull` mode of `{goal-prefix}:start`) or pushing image, it
 might be necessary to authenticate against a Docker registry.
 
 There are five different locations searched for credentials.  In order, these are:
@@ -17,7 +17,7 @@ Using the username and password directly in the `pom.xml` is not
 recommended since this is widely visible. This is the easiest and
 transparent way, though. Using an `<authConfig>` is straight forward:
 
-[source,xml]
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
 ----
 <plugin>
   <configuration>
@@ -38,13 +38,13 @@ the outside:
 .Example
 [source, sh, subs="+attributes"]
 ----
-mvn -Ddocker.username=jolokia -Ddocker.password=s!cr!t {plugin}:push
+mvn -Ddocker.username=jolokia -Ddocker.password=s!cr!t {goal-prefix}:push
 ----
 
 The most _mavenish_ way is to add a server to the Maven settings file `~/.m2/settings.xml`:
 
 .Example
-[source,xml]
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
 ----
 <servers>
   <server>
@@ -84,7 +84,7 @@ can be added. In the example below the credentials provider are only
 used for image push operations:
 
 .Example
-[source,xml]
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
 ----
 <plugin>
   <configuration>
@@ -158,7 +158,7 @@ that you have setup a _master password_ in
 passwords:
 
 .Example
-[source,bash]
+[source, bash, subs="+attributes"]
 ----
 $ mvn --encrypt-password
 Password:

kubernetes-maven-plugin/doc/src/main/asciidoc/inc/_compatibility.adoc

@@ -1,3 +1,4 @@
+ifeval::["{goal-prefix}" == "k8s"]
 
 [[compatibility-with-Kubernetes]]
 = Compatibility with Kubernetes
@@ -20,3 +21,31 @@
 | KMP 0.1.0           |        x          |        ✓          |        ✓          |        ✓          |        ✓          |        ✓         |        ✓         |        ✓         |        ✓         |        ✓         |        ✓
 
 |===
+
+endif::[]
+
+ifeval::["{goal-prefix}" == "oc"]
+
+[[compatibility-with-OpenShift]]
+= Compatibility with OpenShift
+
+[[openshift-compatibility]]
+== OpenShift Compatibility
+
+.OpenShift Compatibility
+|===
+|     OMP             | OpenShift 4.2.0  | OpenShift 3.11.0 | OpenShift 3.10.0 | OpenShift 3.9.0  | OpenShift 3.7.0  | OpenShift 3.6.0  | OpenShift 3.5.0  | OpenShift 1.4.1
+
+| OMP 1.0.0-alpha-2   |        ✓         |        ✓         |        ✓         |        ✓         |         ✓        |        ✓         |        x         |     x
+
+| OMP 1.0.0-alpha-1   |        ✓         |        ✓         |        ✓         |        ✓         |         ✓        |        ✓         |        x         |     x
+
+| OMP 0.2.0           |        ✓         |        ✓         |        ✓         |        ✓         |         ✓        |        ✓         |        x         |     x
+
+| OMP 0.1.1           |        ✓         |        ✓         |        ✓         |        ✓         |         ✓        |        ✓         |        x         |     x
+
+| OMP 0.1.0           |        ✓         |        ✓         |        ✓         |        ✓         |         ✓        |        ✓         |        x         |     x
+
+|===
+
+endif::[]