FOGL-6670 Add documentation for service/asset relationship deprecation (

#766)

* FOGL-6670 Addition of purge on deman to buiding pipelines section

Signed-off-by: Mark Riddoch <[email protected]>

* Fix image display

Signed-off-by: Mark Riddoch <[email protected]>

* Align icon image

Signed-off-by: Mark Riddoch <[email protected]>

* Resolve review comments

Signed-off-by: Mark Riddoch <[email protected]>

* FOGL-6670 Add developer feaures for viewing plugin data from OMF

Signed-off-by: Mark Riddoch <[email protected]>

* Fix image name

Signed-off-by: Mark Riddoch <[email protected]>

* Updated table with type information

Signed-off-by: Mark Riddoch <[email protected]>

* Updates

Signed-off-by: Mark Riddoch <[email protected]>

* Restore tests storage.json

Signed-off-by: Mark Riddoch <[email protected]>

* Remove sqlite.json

Signed-off-by: Mark Riddoch <[email protected]>

* Delete storage.json

* Fixing rogue file

Signed-off-by: Mark Riddoch <[email protected]>

* Fix naming

Signed-off-by: Mark Riddoch <[email protected]>

* FOGL-6670 Add developer feature for deprecating service/asset
relationship

Signed-off-by: Mark Riddoch <[email protected]>

docs/building_pipelines.rst

@@ -9,6 +9,8 @@
 .. |developer_features| image:: images/developer_features.jpg
 .. |manual_purge| image:: images/manual_purge.jpg
 .. |eraser| image:: images/eraser.jpg
+.. |deprecated_1| image:: images/deprecated_1.png
+.. |deprecated_2| image:: images/deprecated_2.png
 
 .. Links
 .. |python35| raw:: html
@@ -83,6 +85,26 @@ These icons are resemble erasers and are located in each row of the assets and a
 
 In both cases a confirmation dialog will be displayed to ensure against accidental use. If you choose to proceed the selected data within the Fledge buffer, either all or a specific asset, will be erased. There is no way to undo this operation or to retrieve the data once it has been purged.
 
+Another consequence that may occur when developing new pipelines is that assets are created during the development process which are not required in the finished pipeline. The asset however remains associated with the service and the asset name and count of number of ingested readings will be displayed in the *South Services* page on the user interface.
+
++----------------+
+| |deprecated_1| |
++----------------+
+
+It is possible to deprecate the relationship between the service and the asset name using the developer features of the user interface. To do this you must first enable *Developer Features* in the user interface settings page. Now when you view the *South Services* page you will see an eraser icon next to each asset listed for a service.
+
++----------------+
+| |deprecated_2| |
++----------------+
+
+If you click on this icon you will be prompted to deprecate the relationship between the asset and the service. If you select *Yes* the relationship will be severed and the asset will no longer appear next to the service.
+
+Deprecating the relationship will not remove the statistics for the asset, it will merely remove the relationship with the service and hence it will not be displayed against the service.
+
+If an asset relationship is deprecated for an asset that is still in use, it will automatically be reinstated the next time a reading is ingested for that asset. Since the statistics were not deleted when the relationship was deprecated the previous readings will still in included in the statistics when the relationship is restored.
+
+These *Developer Features* are designed to be of use when developing pipelines within Fledge, the functionality is not something that should be used in normal operation and the developer features should be turned off when pipelines are not being developed.
+
 Sacrificial North System
 ########################