Fix asciidoc documentation - using attributes subsctitutions in source code snippet.

Author: daggerok

RELEASE.md

@@ -2,7 +2,9 @@
 
 _version: 4.3.1_
 
-Java file server based on spring-boot with no upload / download files size limitation
+## Java file server 
+
+**Java file server** based on *spring-boot* with no memory, upload or download files size limitations
 
 - Update spring-boot version up to 2.0.2.RELEASE. Update some webjars
 - Fix docker-compose / docker files

docs/asciidoc.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 
 asciidoctorj {
-  version = "1.5.5"
+  version = "1.5.6"
 }
 
 asciidoctor {

docs/src/includes/install/download.adoc

@@ -0,0 +1,23 @@
+
+//tag::content[]
+.if you have docker installed and wanna use postgres, then link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/docker-compose.yml[download docker-compose.yaml file]
+[source,bash]
+[subs="verbatim,attributes"]
+----
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/docker-compose.yml
+----
+
+.link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar[file items service]
+[source,bash]
+[subs="specialcharacters,callouts,attributes"]
+----
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar
+----
+
+.link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar[file server]
+[source,bash]
+[subs="specialcharacters,callouts,attributes"]
+----
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar
+----
+//end::content[]

docs/src/includes/install/in-mempry-h2.adoc

@@ -1,16 +1,18 @@
 
 //tag::content[]
-
-.if you do not have docker -- feel free to use h2 in memory database
+.if you do not have docker -- feel free to use h2 in memory database for link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar[file items service]:
+[source,bash]
+[subs="verbatim,attributes"]
 ----
-java file-items-service.jar
+java file-items-service-{project-version}.jar
 # or
 java file-items-service.jar --spring.profiles.active=db-h2
 ----
 
-download files:
-
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar[file-items-service.jar]
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar[file-file-server.jar]
-
+. and then run link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar[file server]:
+[source,bash]
+[subs="specialcharacters,callouts,attributes"]
+----
+java file-items-service-{project-version}.jar --spring.profiles.active=db-h2
+----
 //end::content[]

docs/src/includes/install/postgres-in-docker.adoc

@@ -1,25 +1,19 @@
 
 //tag::content[]
-
+[source,bash]
+[subs="+attributes"]
 .install using postgres in docker
 ----
 # docker compose file for postgres database
 docker-compose up -d
 
 # file-items data service
-java -jar file-items-service.jar --spring.profiles.active=db-pg
+java -jar file-items-service-{project-version}.jar --spring.profiles.active=db-pg
 
 # file server
-java -jar file-server.jar --app.upload.path=./path/to/file-storage
+java -jar file-server-{project-version}.jar --app.upload.path=./path/to/file-storage
 
 # cleanup
 docker-compose down -v
 ----
-
-download files:
-
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/docker-compose.yml[docker-compose.yml],
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar[file-items-service.jar],
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar[file-server.jar]
-
 //end::content[]

docs/src/includes/release/create-new.adoc

@@ -1,6 +1,5 @@
 
 //tag::content[]
-
 to create new release do next
 
 . bump version in:
@@ -13,10 +12,11 @@ to create new release do next
 . comment scipts tests in .travis.yml
 . commit, push and check CI if builds was successfully passed
 . create release on github, put:
-  .. modules/apps/*/build/libs/*
+  .. modules/apps/\*/build/libs/*
   .. scripts/*
   .. docker-modules/postgres
 . uncomment .travis.yml
 . commit, push and check CI again to verify if scripts tests was successfully passed
 
+download all files link:https://github.com/daggerok/streaming-file-server/releases/[here]
 //end::content[]

docs/src/includes/run/executable-jar.adoc

@@ -1,15 +1,12 @@
 
 //tag::content[]
-
 .if you are using bash -- run even simply
+[subs="verbatim,attributes"]
 ----
-bash file-items-service.jar
-bash file-server.jar --app.upload.path=./path/to/file-storage
-----
-
-download files:
-
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar[file-items-service.jar] and
-- link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar[file-server.jar]
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-items-service-{project-version}.jar
+bash file-items-service-{project-version}.jar
 
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/file-server-{project-version}.jar
+bash file-server-{project-version}.jar --app.upload.path=./path/to/file-storage
+----
 //end::content[]

docs/src/includes/run/unix.adoc

@@ -1,9 +1,12 @@
 
 //tag::content[]
-
 .postgres in docker
 [source,bash]
+[subs="+attributes"]
 ----
+# get
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application.bash
+
 # start
 bash application.bash start ./path/to/file-storage
 
@@ -14,11 +17,15 @@ bash application.bash stop
 bash application.bash clean ./path/to/file-storage
 ----
 
-get link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application.bash[application.bash]
+download: link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application.bash[application.bash]
 
 .h2 in-memory database
 [source,bash]
+[subs="+attributes"]
 ----
+# fetch
+wget https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application-h2.bash
+
 # start
 bash application-h2.bash start ./path/to/file-storage
 
@@ -29,8 +36,7 @@ bash application-h2.bash stop
 bash application-h2.bash clean ./path/to/file-storage
 ----
 
-get link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application-h2.bash[application-h2.bash]
+download: link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application-h2.bash[application-h2.bash]
 
 _note: binaries `wget`, `docker-compose` and of course jre (binaries: `java` and `jps`) are required_
-
 //end::content[]

docs/src/includes/run/windows.adoc

@@ -1,6 +1,5 @@
 
 //tag::content[]
-
 .postgres in docker
 [source,cmd]
 ----
@@ -14,7 +13,7 @@ application.cmd stop
 application.cmd clean path\to\file-storage
 ----
 
-get link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application.cmd[application.cmd]
+download: link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application.cmd[application.cmd]
 
 .h2 in-memory database
 [source,bash]
@@ -29,8 +28,7 @@ application-h2.cmd stop
 application-h2.cmd clean path\to\file-storage
 ----
 
-get link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application-h2.cmd[application-h2.cmd]
+download: link:https://github.com/daggerok/streaming-file-server/releases/download/{project-version}/application-h2.cmd[application-h2.cmd]
 
 _note: binaries `wget`, `docker-compose` and of course jre (binaries: `java` and `jps`) are required_
-
 //end::content[]

docs/src/index.adoc

@@ -9,34 +9,33 @@ Maksim Kostromin <daggerok@gmail.com>
 :numbered:
 :github_url: https://github.com/daggerok/streaming-file-server
 :github_project_path: {github_url}/tree/master
+//[discrete]
 
-[discrete]
 == Introduction
-
 link:{github_url}[Streaming file server] -- java based project on top of spring-boot.
 This is a simple file-server which is allowed upload and download files with no memory limitation.
 It uses file multipart protocol
 
 == Installation
+=== download files
+include::./includes/install/download.adoc[tags=content]
 
+== Run
 === postgres database
 include::./includes/install/postgres-in-docker.adoc[tags=content]
-
 === in-memory h2 database
 include::./includes/install/in-mempry-h2.adoc[tags=content]
-
 === take advantages of spring-boot executable jar
 include::./includes/run/executable-jar.adoc[tags=content]
 
+== Usage scripts
 === simplicity bootstrap with automation shell-script
-
 ==== unix (bash)
 include::./includes/run/unix.adoc[tags=content]
-
 ==== windows (batch cmd)
 include::./includes/run/windows.adoc[tags=content]
 
-==== create new release
+== Create new release
 include::./includes/release/create-new.adoc[tags=content]
 
 ---