Skip to content

Commit bb3a3d0

Browse files
author
James Gorlick
committed
fixed hugo upgrade to 0.19 regression, moving the RRA uml deployment diagram sources to public_src. added a note to the README about the process of generating from such sources, including the nudge to make the generation repeatable via a script.
1 parent d031e92 commit bb3a3d0

File tree

6 files changed

+28
-0
lines changed

6 files changed

+28
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ for our scripting and styling needs, and we convert those files to `.js` and
6868
`.css` as a pre-render step. We put those `.coffee` and `.scss` files into the
6969
`dynamic/` directory.
7070
71+
>**Note:** For files manually generated, place the source of the generation in
72+
a directory parallel to the generated file(s), rooted in `public_src/`. If
73+
possible, include a script to generate the output. For example, the uml
74+
deployment diagram images in `static/images/redis/` were generated by the .uml
75+
files in `public_src/images/redis/` via the script `gen_diagrams.sh` w/ the list
76+
of source files for generation explicitly listed in `diagrams.lst`.
77+
7178
To convert the Coffee and Sass into `.js` and `.css` files, you'll need to:
7279
7380
1. **Install [RVM][rvm]** or equivalent.

public_src/images/redis/diagrams.lst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
rra_deployment_local.uml
2+
rra_deployment_colocated.uml
3+
rra_deployment_distributed.uml
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/bin/sh
2+
function assert_dependencies () {
3+
assert_dependency_plantuml
4+
}
5+
6+
function assert_dependency_plantuml () {
7+
if [ -z $(which plantuml) ]; then
8+
echo "plantuml is required, \`brew install plantuml\` or equivalent" >&2
9+
exit 1
10+
fi
11+
}
12+
assert_dependencies
13+
14+
# generate uml diagrams to parallel static dir
15+
for uml_src in $(cat diagrams.lst); do
16+
uml_dest=$(echo "${uml_src%.*}.png")
17+
cat $uml_src |plantuml -pipe >../../../static/images/redis/$uml_dest
18+
done

0 commit comments

Comments
 (0)