[#11732] Broken PUML diagrams in developer guide (#11734)

TEAMMATES · Apr 14, 2022 · 10275d5 · 10275d5
1 parent 02f8078
commit 10275d5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.github/workflows/dev-docs.yml b/.github/workflows/dev-docs.yml
@@ -21,6 +21,12 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: 12
+      - uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Install Graphviz
+        run: sudo apt install graphviz
       - run: npm ci
       - run: npm run build
       - name: Check build status

diff --git a/docs/documentation.md b/docs/documentation.md
@@ -13,6 +13,11 @@ All the commands in this document are assumed to be run from the `/docs` folder,
 1. Install `Node.js` (minimum version 12).
 1. Run `npm ci` to install the necessary tools to build documentation, including MarkBind.
 
+Install the following additional dependencies required by MarkBind to generate [PlantUML](https://plantuml.com/) diagrams locally:
+
+1. Install Java 8 or later.
+1. Install [Graphviz](https://www.graphviz.org/download/) v2.38 (or later).
+
 <box type="tip" light>
 
 You can also use a globally installed MarkBind if you have one. Make sure to use version `3.*.*`.