From 8bcb89b5c1b7acf62a6f87dabd8b5df9f4570b51 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Sat, 4 Nov 2017 08:54:05 +0000 Subject: Convert MD files to RST Change-Id: Ie686349006f03d58bc8b526a7f76754dc1da2507 ISSUE-ID: AAI-255 Signed-off-by: Eric Debeau --- docs/view_inspect.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/view_inspect.rst (limited to 'docs/view_inspect.rst') diff --git a/docs/view_inspect.rst b/docs/view_inspect.rst new file mode 100644 index 0000000..d25f95f --- /dev/null +++ b/docs/view_inspect.rst @@ -0,0 +1,44 @@ +.. 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. -- cgit 1.2.3-korg