diff --git a/README.md b/README.md index 05d99dd..d55e0b1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# Documentation +# swarmlab docs + +A [swarmlab.io](http://www.swarmlab.io) sidecar container. + +Documentation is a multi-repository site generator (Antora based) + + +## Build from git + +> git clone https://git.swarmlab.io:3000/docs/Documentation.git +> +> cd docs +> ./build.sh +> +> + diff --git a/build-intro.sh b/build-intro.sh new file mode 100755 index 0000000..1be31ee --- /dev/null +++ b/build-intro.sh @@ -0,0 +1,5 @@ +docker stop swarmlab-documentation +docker container rm swarmlab-documentation +docker pull hub.swarmlab.io:5480/antora + +docker run -ti --name swarmlab-documentation -v $PWD/docs:/antora hub.swarmlab.io:5480/antora /bin/sh -c "DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr DOCSEARCH_INDEX_VERSION=latest NODE_PATH=/usr/local/lib/node_modules:\$NODE_PATH exec sh -c '/antora/run/build-intro.sh'" diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..42fca05 --- /dev/null +++ b/build.sh @@ -0,0 +1,11 @@ +docker stop swarmlab-documentation +docker container rm swarmlab-documentation +docker pull hub.swarmlab.io:5480/antora + +antora --fetch site.yml +antora site.yml +ifconfig +http-server build/site -c-1 + + +docker run -ti --name swarmlab-documentation -v $PWD/docs:/antora hub.swarmlab.io:5480/antora /bin/sh -c "DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr DOCSEARCH_INDEX_VERSION=latest NODE_PATH=/usr/local/lib/node_modules:\$NODE_PATH exec sh -c 'build.sh'" diff --git a/code/my_app.rb b/code/my_app.rb new file mode 100644 index 0000000..b691710 --- /dev/null +++ b/code/my_app.rb @@ -0,0 +1,21 @@ +# This file represents "software". +# This file helps show that documentation files can be in the same repository as software. + +rescue => ex + begin + context = %(asciidoctor: FAILED: #{attrs['docfile'] || ''}: Failed to load AsciiDoc document) + if ex.respond_to? :exception + # The original message must be explicitely preserved when wrapping a Ruby exception + wrapped_ex = ex.exception %(#{context} - #{ex.message}) + # JRuby automatically sets backtrace, but not MRI + wrapped_ex.set_backtrace ex.backtrace + else + # Likely a Java exception class + wrapped_ex = ex.class.new context, ex + wrapped_ex.stack_trace = ex.stack_trace + end + rescue + wrapped_ex = ex + end + raise wrapped_ex +end diff --git a/docs/run/build-intro.sh b/docs/run/build-intro.sh new file mode 100755 index 0000000..af181d8 --- /dev/null +++ b/docs/run/build-intro.sh @@ -0,0 +1,4 @@ +antora --fetch /antora/site-intro.yml +antora /antora/site-intro.yml +ifconfig +http-server build/site -c-1 diff --git a/docs/site-intro.yml b/docs/site-intro.yml new file mode 100644 index 0000000..9734959 --- /dev/null +++ b/docs/site-intro.yml @@ -0,0 +1,21 @@ +site: + title: Swarmlab sec-intro + url: http://docs.swarmlab.io/SwarmLab-HowTos/swarmlab/docs + start_page: swarmlab::index.adoc +content: + sources: + - url: https://git.swarmlab.io:3000/docs/Documentation.git + branches: master + start_path: docs +ui: + bundle: + url: https://git.swarmlab.io:3000/docs/docs/raw/branch/master/ui-bundle.zip + snapshot: true + supplemental_files: ./supplemental-ui +asciidoc: + attributes: + :plantuml-server-url: http://www.plantuml.com/plantuml + extensions: + - '@djencks/asciidoctor-mathjax' + - asciidoctor-plantuml + diff --git a/docs/site.yml b/docs/site.yml index cfbf30b..9734959 100644 --- a/docs/site.yml +++ b/docs/site.yml @@ -1,7 +1,7 @@ site: - title: General Documentation + title: Swarmlab sec-intro url: http://docs.swarmlab.io/SwarmLab-HowTos/swarmlab/docs - start_page: swarmlab::index.adoc + start_page: swarmlab::index.adoc content: sources: - url: https://git.swarmlab.io:3000/docs/Documentation.git @@ -9,5 +9,13 @@ content: start_path: docs ui: bundle: - url: https://git.swarmlab.io:3000/docs/Documentation/raw/branch/master/ui-bundle.zip + url: https://git.swarmlab.io:3000/docs/docs/raw/branch/master/ui-bundle.zip snapshot: true + supplemental_files: ./supplemental-ui +asciidoc: + attributes: + :plantuml-server-url: http://www.plantuml.com/plantuml + extensions: + - '@djencks/asciidoctor-mathjax' + - asciidoctor-plantuml +