FINERACT-1608: Add introduction to Asciidoc

Author: vidakovic

README.md

@@ -338,7 +338,7 @@ complies with the [Apache Software Foundation third-party license policy](https:
 Apache Fineract Platform API
 ============
 
-The API for Fineract is documented in [apiLive.htm](fineract-provider/src/main/resources/static/api-docs/apiLive.htm), and the [apiLive.htm can be viewed on Fineract.dev](https://demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm "API Documentation").  If you have your own Fineract instance running, you can find this documentation under [/fineract-provider/api-docs/apiLive.htm](https://localhost:8443/fineract-provider/api-docs/apiLive.htm).
+The API for Fineract is documented in [apiLive.htm](fineract-provider/src/main/resources/static/api-docs/apiLive.htm), and the [apiLive.htm can be viewed on Fineract.dev](https://fineract.apache.org/legacy-docs/apiLive.htm "API Documentation").  If you have your own Fineract instance running, you can find this documentation under [/fineract-provider/api-docs/apiLive.htm](https://localhost:8443/fineract-provider/api-docs/apiLive.htm).
 
 The Swagger documentation (work in progress; see [FINERACT-733](https://issues.apache.org/jira/browse/FINERACT-733)) can be accessed under [/fineract-provider/swagger-ui/index.html](https://localhost:8443/fineract-provider/swagger-ui/index.html) and [live Swagger UI here on Fineract.dev](https://demo.fineract.dev/fineract-provider/swagger-ui/index.html).
 

fineract-client/build.gradle

@@ -93,6 +93,20 @@ task buildAsciidoc(type: org.openapitools.generator.gradle.plugin.tasks.Generate
     apiPackage = 'org.apache.fineract.client.services'
     invokerPackage = 'org.apache.fineract.client'
     modelPackage = 'org.apache.fineract.client.models'
+    configOptions = [
+        appName: 'Apache Fineract REST API',
+        appDescription: '''Apache Fineract is a secure, multi-tenanted microfinance platform.
+            The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform.
+            The https://cui.fineract.dev[reference app] (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation.
+            Until we complete the new REST API documentation you still have the legacy documentation available https://fineract.apache.org/legacy-docs/apiLive.htm[here].
+            Please check https://fineract.apache.org/docs/current[the Fineract documentation] for more information.''',
+        headerAttributes: 'false',
+        infoEmail: 'dev@fineract.apache.org',
+        infoUrl: 'https://fineract.apache.org',
+        licenseInfo: 'Apache 2.0',
+        licenseUrl: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+        useMethodAndPath: 'true'
+    ]
     dependsOn(':fineract-provider:resolve')
 }
 

fineract-doc/build.gradle

@@ -57,7 +57,7 @@ asciidoctor {
     }
     outputDir 'build/docs/html'
 
-    dependsOn ':fineract-client:buildAsciidoc'
+    dependsOn(':fineract-client:clean', ':fineract-client:buildAsciidoc')
 }
 
 // asciidoctorEpub {
@@ -92,11 +92,11 @@ asciidoctorPdf {
     //     }
     // }
     // fontsDir "$projectDir/src/resources/fonts"
-    dependsOn ':fineract-client:buildAsciidoc'
+    dependsOn(':fineract-client:clean', ':fineract-client:buildAsciidoc')
 }
 
 task doc(type: Zip) {
-    dependsOn asciidoctor, asciidoctorPdf
+    dependsOn(asciidoctor, asciidoctorPdf)
 
     into("fineract-${project.version}/html") {
         from("$buildDir/docs/html") {

fineract-doc/src/docs/en/chapters/documentation/asciidoc-cheatsheet.adoc

@@ -1,9 +1,3 @@
-= Asciidoc
-
-See: https://asciidoctor.org/
-
-TBD
-
-include::asciidoc-tutorial.adoc[leveloffset=+1]
+= AsciiDoc
 
 include::asciidoc-cheatsheet.adoc[leveloffset=+1]

fineract-doc/src/docs/en/chapters/documentation/asciidoc-tutorial.adoc

@@ -0,0 +1,5 @@
+= Archimate Cheatsheet
+
+TBD
+
+NOTE: https://www.opengroup.org/archimate-forum/archimate-overview and https://plantuml.com/archimate-diagram

fineract-doc/src/docs/en/chapters/documentation/asciidoc.adoc

@@ -0,0 +1,5 @@
+= C4 Cheatsheet
+
+TBD
+
+NOTE: https://c4model.com and https://github.com/plantuml-stdlib/C4-PlantUML

fineract-doc/src/docs/en/chapters/documentation/diagram-archimate-cheatsheet.adoc

@@ -0,0 +1,5 @@
+= PlantUML Cheatsheet
+
+TBD
+
+NOTE: https://plantuml.com

fineract-doc/src/docs/en/chapters/documentation/diagram-c4-cheatsheet.adoc

@@ -0,0 +1,5 @@
+= Vega Cheatsheet
+
+TBD
+
+NOTE: https://vega.github.io/vega-lite/