Try uml diagram one more time

whole-tale · Feb 20, 2018 · 381bd4e · 381bd4e
1 parent d1d688d
commit 381bd4e
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,5 @@
+build:
+    image: latest
+
+python:
+    version: 2
diff --git a/conf.py b/conf.py
@@ -32,7 +32,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.intersphinx',
-    'sphinx.ext.githubpages']
+              'sphinx.ext.githubpages',
+              'sphinxcontrib.plantuml']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/mockups/tale-publishing/README.rst b/mockups/tale-publishing/README.rst
@@ -197,3 +197,22 @@ TODOS
 - Deal with the Globus side of this
 - Find out how much we can instrument Girder to get provenance information for which script read which files
 
+
+.. uml::
+
+    @startuml diag
+      User -> Dashboard: Clicks "Publish"
+      activate Dashboard
+      Dashboard -> Backend: req saveTale(id)
+      activate Backend
+      loop each item
+        Backend -> Repository: createObject
+        Repository --> Backend: objectCreated
+      end
+      Backend -> Repository: req createPackage
+      Repository --> Backend: resp packageCreated
+      Backend --> Dashboard: resp taleSaved(id)
+      deactivate Backend
+      Dashboard --> User: Updates UI
+      deactivate Dashboard
+    @enduml
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+sphinxcontrib-plantuml