Merge pull request 'add asciidoctor plugin' (#8) from add_aciidoctor into master

Reviewed-on: #8

README.md

@@ -4,7 +4,7 @@
 
 [Russian](README.ru.md)
 
-Detailed documentation: [system description](documentation/entaxy_main.adoc).\
+Detailed documentation: [system description](documentation/index.adoc).\
 Assembly and installation instructions: [installation](documentation/installation/installation-table-of-contents.ru.adoc).\
 Instructions for running tests for the universal
 service: [tests](documentation/connectors/uniform-exchange-service/tests/postman.adoc).

README.ru.md

@@ -3,6 +3,6 @@
 ### Languages
 [English](README.md)
 
-Подробная документация: [описание системы](documentation/entaxy_main.adoc).\
+Подробная документация: [описание системы](documentation/index.adoc).\
 Инструкция по сборке и установке: [установка](documentation/installation/installation-table-of-contents.ru.adoc).\
 Инструкция по запуску тестов для универсального коннектора: [тестирование](documentation/connectors/uniform-exchange-service/tests/postman.adoc).

pom.xml

@@ -80,6 +80,8 @@
         <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
         <maven-install-plugin.version>2.5.2</maven-install-plugin.version>
         <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
+        <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
+        <maven-dependency-plugin.version>3.1.2</maven-dependency-plugin.version>
     </properties>
 
     <dependencyManagement>
@@ -275,6 +277,21 @@
                     <artifactId>maven-deploy-plugin</artifactId>
                     <version>${maven-deploy-plugin.version}</version>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-dependency-plugin</artifactId>
+                    <version>${maven-dependency-plugin.version}</version>
+                </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-assembly-plugin</artifactId>
+                    <version>${maven-assembly-plugin.version}</version>
+                </plugin>
+	            <plugin>
+	                <groupId>org.apache.maven.plugins</groupId>
+	                <artifactId>maven-antrun-plugin</artifactId>
+	                <version>3.0.0</version>
+	            </plugin>
             </plugins>
         </pluginManagement>
         <plugins>
@@ -331,18 +348,18 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-dependency-plugin</artifactId>
-                <version>3.1.2</version>
+                <version>${maven-dependency-plugin.version}</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-antrun-plugin</artifactId>
-                <version>3.0.0</version>
             </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>build-helper-maven-plugin</artifactId>
                 <version>3.2.0</version>
             </plugin>
+
             <!-- CICD stuff -->
             <!--            <plugin>-->
             <!--                <groupId>org.apache.maven.plugins</groupId>-->
@@ -359,7 +376,7 @@
             <!--            <plugin>-->
             <!--                <groupId>org.codehaus.mojo</groupId>-->
             <!--                <artifactId>build-helper-maven-plugin</artifactId>-->
-            <!--                <version>1.8.0</version>-->
+            <!--                <version>1.8</version>-->
             <!--                <inherited>false</inherited>-->
             <!--                <executions>-->
             <!--                    <execution>-->
@@ -377,7 +394,7 @@
             <!--              <plugin>-->
             <!--                <groupId>org.apache.maven.plugins</groupId>-->
             <!--                <artifactId>maven-antrun-plugin</artifactId>-->
-            <!--                <version>1.8.0</version>-->
+            <!--                <version>1.8</version>-->
             <!--                <executions>-->
             <!--                    <execution>-->
             <!--                        <inherited>false</inherited>-->
@@ -542,6 +559,97 @@
                 </file>
             </activation>
         </profile>
+        <profile>
+            <id>asciidoctor</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.asciidoctor</groupId>
+                        <artifactId>asciidoctor-maven-plugin</artifactId>
+                        <version>2.2.1</version>
+                        <executions>
+                            <execution>
+                                <id>convert-to-html</id>
+                                <phase>generate-resources</phase>
+                                <goals>
+                                    <goal>process-asciidoc</goal>
+                                </goals>
+                                <configuration>
+                                    <sourceDirectory>documentation</sourceDirectory>
+                                    <outputDirectory>${project.build.directory}/documentation</outputDirectory>
+                                    <preserveDirectories>true</preserveDirectories>
+                                    <attributes>
+                                        <source-highlighter>coderay</source-highlighter>
+                                        <toc>left</toc>
+                                        <icons>font</icons>
+
+                                        <sectanchors>true</sectanchors>
+                                        <!-- set the idprefix to blank -->
+                                        <idprefix/>
+                                        <idseparator>-</idseparator>
+                                        <docinfo1>true</docinfo1>
+                                        <stylesdir>_styles</stylesdir>
+                                        <stylesheet>entaxy.css</stylesheet>
+                                        <linkcss>false</linkcss>
+                                        <copyright>EmDev LLC</copyright>
+                                    </attributes>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+
+		            <plugin>
+		                <groupId>org.apache.maven.plugins</groupId>
+		                <artifactId>maven-antrun-plugin</artifactId>
+		                <executions>
+		                	<execution>
+		                		<id>postprocess-html</id>
+                                <phase>generate-resources</phase>
+                                <goals>
+                                    <goal>run</goal>
+                                </goals>
+		                		<configuration>
+		                			<target>
+										<replaceregexp byline="true">
+										    <regexp pattern="link([^>])+https://cdnjs.cloudflare.com([^>])+>"/>
+										    <substitution expression="!-- link is removed -->"/>
+										    <fileset dir="${project.build.directory}/documentation" includes="**/*.html">
+										    </fileset>
+										</replaceregexp>		                			
+		                			</target>
+		                		</configuration>
+		                	</execution>
+		                </executions>
+		            </plugin>
+
+                    <plugin>
+                        <artifactId>maven-assembly-plugin</artifactId>
+                        <version>${maven-assembly-plugin.version}</version>
+                        <executions>
+                            <execution>
+                                <id>assebmly</id>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>single</goal>
+                                </goals>
+                                <configuration>
+                                    <finalName>documents</finalName>
+                                    <appendAssemblyId>true</appendAssemblyId>
+                                    <descriptors>
+                                        <descriptor>src/documentation/assembly/assembly.xml</descriptor>
+                                    </descriptors>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+            <activation>
+                <file>
+                    <exists>documentation/index.adoc</exists>
+                </file>
+            </activation>
+        </profile>
 
         <!-- localize all the licensing functionality to autostarting (for now) profile -->
         <profile>

src/documentation/assembly/assembly.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~~~~~~licensing~~~~~~
+  entaxy-assembly
+  ==========
+  Copyright (C) 2020 - 2021 EmDev LLC
+  ==========
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  ~~~~~~/licensing~~~~~~
+  -->
+
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
+    <id>documentation</id>
+    <baseDirectory>entaxy-documentation-${project.version}</baseDirectory>
+    <formats>
+        <format>zip</format>
+    </formats>
+    <fileSets>
+        <fileSet>
+            <directory>${project.build.directory}/documentation</directory>
+            <includes>
+                <include>**/*</include>
+            </includes>
+            <outputDirectory>/</outputDirectory>
+        </fileSet>
+    </fileSets>
+</assembly>