Convert MD files to RST

[aai/sparky-be.git] / docs / vnfs.rst

diff --git a/docs/vnfs.rst b/docs/vnfs.rst
new file mode 100644 (file)
index 0000000..e7f39ef
--- /dev/null
+++ b/docs/vnfs.rst
@@ -0,0 +1,25 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Sparky - Inventory UI Service
+=============================
+
+*VNFs* Overview
+~~~~~~~~~~~~~~~
+
+*VNFs* is an aggregation based view that provides aggregate counts of
+VNFs based off of provsioning status and orchestration status.
+
+Navigation to *VNFs*
+~~~~~~~~~~~~~~~~~~~~
+
+1. Main navigation menu
+2. Selecting a search result related to an aggregation result (e.g. and
+   VNFs)
+
+Using *VNFs*
+~~~~~~~~~~~~
+
+*VNFs* is driven by using the search bar at the top of the UI to find
+and select aggregation queries. Once selected, the aggregation queries
+will be sent to the *Sparky* backend component for processing. When a
+result set has been determined *VNFs* will render the data.