Skip to content
Permalink
Browse files
move uxf diagrams and render them with kroki
  • Loading branch information
djencks committed May 11, 2021
1 parent 8bc299a commit 2a78c7ef9f64a5c70d66a940debe5a92d2cb3e47
Showing 8 changed files with 63 additions and 5 deletions.
@@ -192,10 +192,53 @@ This may be facilitated in jetbrains products with an on-page regex search/repla

=$1`.

There are numerous classes of problems this does not cover.
The first step is probably to eliminate the command line errors/warnings.

== Auto index pages

Add to {project}-antora package.json devDependencies `"@djencks/asciidoctor-antora-indexer": "^0.0.4"`

Run `npm run clean-install`.

To the `antora-playbook.yml` playbook add

[source,yml]
----
asciidoc:
extensions:
- "@djencks/asciidoctor-antora-indexer"
----

Add a page `auto-index.adoc` to the {project-site} project containing

[source,adoc]
----
= Temporary auto-index page
//uncomment to generate temporary nav file contents on console.
:antora-indexer-log-lists:
indexList::[]
----

Run `npm run build`.
You should see an adoc list output on the console, listing all pages in order.

== Construct nav file

Copy this list from the console to the empty `nav.adoc`.

== Move images

[source,console]
----
echo '#!/bin/sh' >move-png.sh
find modules -name "*.png" -exec sh -c 'echo mkdir -p `dirname $0`\\ngit mv $0 $0' {} \; |sed 's/\([gp]\) modules\/ROOT\/pages/\1 modules\/ROOT\/images/g' >>move-png.sh
chmod u+x move-png.sh
./move-png.sh
---
You may need to move pngs with spaces in their filenames by hand.
== Fix xrefs
@@ -15,7 +15,10 @@ Being able to declare such dependencies in code ensures consistent life cycle be

=== Structure

image::./diagrams/singleton.png[Singleton,190]
[umlet,opts=inline]
----
include::example$documentation/subprojects/apache-felix-dependency-manager/guides/diagrams/singleton.uxf[]
----

=== Code Example

@@ -51,7 +54,10 @@ This allows you to dynamically add and remove aspects.

=== Structure

image::./diagrams/aspect.png[Aspect,190]
[umlet,opts=inline]
----
include::example$documentation/subprojects/apache-felix-dependency-manager/guides/diagrams/aspect.uxf[]
----

=== Code Example

@@ -91,7 +97,10 @@ Adapters can dynamically be added and removed and allow you to keep your basic s

=== Structure

image::./diagrams/adapter.png[Adapter,190]
[umlet]
----
include::example$documentation/subprojects/apache-felix-dependency-manager/guides/diagrams/adapter.uxf[png]
----

=== Code Example

@@ -134,7 +143,10 @@ They can be implemented to serve resources embedded in bundles, somewhere on a f

=== Structure

image::./diagrams/resourceadapter.png[Singleton,180]
[umlet]
----
include::example$documentation/subprojects/apache-felix-dependency-manager/guides/diagrams/resourceadapter.uxf[png]
----

== Temporal Dependency

@@ -6,7 +6,10 @@ bundle resources, files, database records, anything as long as it can be resolve

The diagram below illustrates the classes involved in the resource adapter pattern:

image::./diagrams/resources.png[Resource adapters,780]
[umlet,opts=inline]
----
include::example$documentation/subprojects/apache-felix-dependency-manager/guides/diagrams/resources.uxf[]
----

The yellow elements have to be implemented in order to use the pattern.

0 comments on commit 2a78c7e

Please sign in to comment.