diff options
Diffstat (limited to 'docs/view_inspect.rst')
| -rw-r--r-- | docs/view_inspect.rst | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/docs/view_inspect.rst b/docs/view_inspect.rst deleted file mode 100644 index d25f95f..0000000 --- a/docs/view_inspect.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Sparky - Inventory UI Service -============================= - -*View & Inspect* Overview -~~~~~~~~~~~~~~~~~~~~~~~~~ - -*View & Inspect* provides a graph based view of elements within AAI. A -single entity is the entry point into each graph, and from that base -element a graph is generated based off relationships. - -Navigation to *View & Inspect* -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The *View & Inspect* view can be reached by two means: - -1. Main navigation menu -2. Selecting a search result related to an entity instance (e.g. an - entity called readme-entity) - -Using *View & Inspect* -~~~~~~~~~~~~~~~~~~~~~~ - -*View & Inspect* is driven by using the search bar at the top of the UI -to find and select entity instances. Once an instance has been slected, -a request is proccessed in *Sparky's* backend component that generates a -graph representation of the selected entity. The graph data is returned -to *View & Inspect* and rendered on screen. - -Node Details -^^^^^^^^^^^^ - -Upon node selection, the selected graph node details will appear in a -panel to the right of the graph titled, *Node Details*. - -Interacting with the Graph -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The graph can be panned by clicking and holding empty space amongst the -graph and moving the mouse. This will pan the entire graph. The graph -can be zoomed in and out by using a mouse scroll wheel. Nodes in the -graph can be select by clicking on them. Nodes in the graph can be moved -by clicking, holding, and dragging them using the mouse. |