Backups page and illustrations revision

Projects/Superalgos/Schemas/Docs-Topics/productivity-tools-001-backups.json

@@ -14,19 +14,23 @@
         },
         {
             "style": "Text",
-            "text": "When you back up a single node, a structure of nodes, a complete hierarchy or even the workspace, all existing references are stored in the resulting JSON file."
+            "text": "When you back up a Node, a structure of nodes, a complete hierarchy, or even the Workspace, all existing references are stored in the resulting JSON file.",
+            "updated": 1615823255327
         },
         {
             "style": "Text",
-            "text": "When you restore a workspace backup, the current workspace is discarded entirely and replaced with the backup. Now, let’s see what happens when you restore anything other than a workspace, that is, any of the data structures contained in the workspace."
+            "text": "When you restore a workspace backup, the current workspace is replaced with the backup.",
+            "updated": 1615820832685
         },
         {
             "style": "Text",
-            "text": "In particular, what we want to analyze is what happens with each type of reference that may be present in the structure."
+            "text": "Now, let’s see what happens when you restore anything other than a workspace, that is, any of the data structures contained in the workspace. What we want to analyze is what happens with references that may be present in the structure, in particular, with the different types of references.",
+            "updated": 1615820914384
         },
         {
-            "style": "Text",
-            "text": "What happens with each type of reference when the back up is restored varies depending on one factor: the original structure is present in the workspace, or instead, it has been deleted prior to restoring the backup."
+            "style": "Success",
+            "text": "When a backup is restored, what happens with each type of reference varies depending on one factor: Is the original structure present in the workspace? Or has the structure been deleted before restoring the backup?",
+            "updated": 1615823276285
         },
         {
             "style": "Title",
@@ -34,11 +38,13 @@
         },
         {
             "style": "Callout",
-            "text": "Outgoing references are kept no matter if the original structure of nodes still exists or not."
+            "text": "Outgoing references are kept intact no matter if the original structure of nodes still exists or not.",
+            "updated": 1615821071450
         },
         {
             "style": "Text",
-            "text": "For example, in a task set up for running a testing session, the trading bot process instance references the trading bot Multi-Period process, and the session references a trading sytem."
+            "text": "For example, in a Task set up to run a Backtesting Session, the Trading Process Instance references the Trading Bot Multi-Period process, the Trading System Reference references a Trading System, and the Trading Engine Reference references the Trading Engine. These are all outgoing references relative to the structure of nodes that make up a Task.",
+            "updated": 1615823380296
         },
         {
             "style": "Gif",
@@ -47,11 +53,13 @@
         },
         {
             "style": "Text",
-            "text": "As the capture above shows, when restoring the backup of a task, both outgoing references are maintained, even when the original task has not been deleted."
+            "text": "As the capture above shows, when restoring the backup of a Task, the three outgoing references are maintained, even when the original task has not been deleted.",
+            "updated": 1615821379213
         },
         {
-            "style": "Text",
-            "text": "This means that restoring a back up is a viable way to duplicate structures of nodes with outgoing references when you expect outgoing references to be preserved."
+            "style": "Success",
+            "text": "This means that restoring a backup is a viable way to duplicate structures of nodes with outgoing references when you expect outgoing references to be preserved.",
+            "updated": 1615821244593
         },
         {
             "style": "Title",
@@ -63,7 +71,8 @@
         },
         {
             "style": "Text",
-            "text": "Let’s take a trading system as an example. Trading systems usually have several incoming references originating at different testing and live trading sessions."
+            "text": "Let’s take a Trading System as an example. Trading systems usually have several incoming references originating at different testing and live trading sessions.",
+            "updated": 1615821415989
         },
         {
             "style": "Gif",
@@ -72,11 +81,13 @@
         },
         {
             "style": "Text",
-            "text": "The capture above shows that restoring a backup of a trading system when the orginal definition is still in the workspace causes the incoming references to be lost."
+            "text": "The capture above shows that restoring a backup of a trading system when the original definition is still in the workspace causes the incoming references to be lost. This is because the backup is restored with new IDs on each node.",
+            "updated": 1615822161951
         },
         {
             "style": "Text",
-            "text": "However, as the capture below shows, if the original structure of nodes is deleted before the backup is restored, then the incoming references are restored as well."
+            "text": "However, as the capture below shows, if the original structure of nodes is deleted before the backup is restored, then the incoming references are restored as well. This is because deleting the original structure releases the IDs of the nodes involved and allows recreating the structure with the same IDs each of the nodes used to have.",
+            "updated": 1615822180175
         },
         {
             "style": "Gif",
@@ -89,11 +100,13 @@
         },
         {
             "style": "Text",
-            "text": "Internal references are kept internally only when the original structure of nodes is deleted before restoring the backup. If the original structure of nodes is present, then the references will point to the original nodes on the original structure of nodes."
+            "text": "Internal references remain to be internal references only when the original structure of nodes is deleted before restoring the backup. If the original structure of nodes is present, then the references will point to the original nodes on the original structure of nodes.",
+            "updated": 1615822737609
         },
         {
             "style": "Text",
-            "text": "Let’s see what happens when we restore a backup of a shapes node without deleting the original node first:"
+            "text": "Let’s see what happens when we restore a backup of a Shapes node without deleting the original node first:",
+            "updated": 1615822610298
         },
         {
             "style": "Gif",
@@ -102,7 +115,8 @@
         },
         {
             "style": "Text",
-            "text": "As expected, the references from vertices in the restored backup do not point to the points in the same structure, but instead point to the original points in the original strucutre."
+            "text": "As expected, the references from vertices in the restored backup do not point to the points in the same structure, but instead, point to the original points in the original structure.",
+            "updated": 1615823436326
         },
         {
             "style": "Text",
@@ -113,6 +127,11 @@
             "text": "GIFs/Superalgos/Docs/design-space/backups-05.gif",
             "updated": 1611490016934
         },
+        {
+            "style": "Success",
+            "text": "To understand this behavior you must consider —again— what happens with the IDs of the nodes involved! In the first case, when you delete the structure of nodes before the backup is restored, the IDs are freed so that when the backup is restored, the nodes may be restored with the same IDs they used to have. This allows for the references to be kept as they used to be. In the second case, the IDs are already taken and the nodes are created with new IDs. This results in the references pointing to the original nodes, instead of the ones that were restored from the backup.",
+            "updated": 1615823179782
+        },
         {
             "style": "Title",
             "text": "Conclusion"
@@ -123,8 +142,8 @@
         },
         {
             "style": "Text",
-            "text": "However, the tool’s particular behavior when restoring a backup without deleting the original structure may be of use in certain ocassions. In such cases, the backup feature behaves differently than the clone feature.",
-            "updated": 1611490099609
+            "text": "However, the tool’s particular behavior when restoring a backup without deleting the original structure may be of use on certain occasions. In such cases, the backup feature behaves differently than the clone feature.",
+            "updated": 1615823501537
         },
         {
             "style": "Text",

Projects/Superalgos/Schemas/Docs-Topics/troubleshooting-006-perception-issues-my-system-gets-slow.json

@@ -56,7 +56,8 @@
         },
         {
             "style": "Text",
-            "text": "Make sure you set the time scale to manual mode and adjust it so that fewer candles are displayed on the screen. Try switching the time frame box to the higher time frames so that candle density decreases."
+            "text": "Make sure you set the Time Scale to manual mode and adjust it so that fewer candles are displayed on the screen. Try switching the time frame box to the higher time frames so that candle density decreases.",
+            "updated": 1615810255059
         },
         {
             "style": "Text",

Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-029-tutorial-step-back-to-backups.json

@@ -0,0 +1,24 @@
+{
+    "tutorial": "Basic Education",
+    "pageNumber": "29",
+    "type": "Tutorial Step - Back to Backups!",
+    "definition": {
+        "text": "Now that you understand references, we can go deeper into Backups, and maybe even discuss the differences with Clones!",
+        "updated": 1615813066430,
+        "icon": {
+            "name": "backup-entity",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Callout",
+            "text": "You've got some more reading to do! Please, read this page carefully!",
+            "updated": 1615813138435
+        },
+        {
+            "style": "Text",
+            "text": "asdf"
+        }
+    ]
+}