Skip to content

Commit

Permalink
Try uml diagram one more time
Browse files Browse the repository at this point in the history
  • Loading branch information
Xarthisius committed Feb 20, 2018
1 parent d1d688d commit 986b772
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 21 deletions.
5 changes: 5 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
build:
image: latest

python:
version: 2
3 changes: 2 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down
20 changes: 18 additions & 2 deletions mockups/tale-publishing/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,24 @@ TODO: Do we implement the API as a single call, or many calls for each item? We
Sequence Diagram
~~~~~~~~~~~~~~~~

.. image:: images/sequence-diagram.png
.. 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

Terms:

Expand All @@ -196,4 +213,3 @@ 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

Binary file removed mockups/tale-publishing/images/sequence-diagram.png
Binary file not shown.
18 changes: 0 additions & 18 deletions mockups/tale-publishing/src/sequence-diagram.plantuml

This file was deleted.

1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinxcontrib-plantuml

0 comments on commit 986b772

Please sign in to comment.