Merge pull request #695 from julian-molina/develop

Contribution: Basic Education Tutorial

Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-004-tutorial-step-starting-from-a-plugin.json

@@ -0,0 +1,25 @@
+{
+    "tutorial": "Basic Education",
+    "pageNumber": "4",
+    "type": "Tutorial Step - Starting From a Plugin",
+    "definition": {
+        "text": "A typical case is when you wish to introduce changes to a strategy shipping with the system to start with a proven setup!",
+        "icon": {
+            "name": "trading-system",
+            "project": "Superalgos"
+        },
+        "updated": 1615995229226
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Let's say you are just starting with Superalgos, did a few tutorials, and are ready to start playing with a strategy. You want to start with an existing strategy and introduce minor modifications to better understand how things work. The strategy in question is included as a plugin in a specific workspace.",
+            "updated": 1615995721361
+        },
+        {
+            "style": "Success",
+            "text": "In such cases, you must delete the Plugin File node corresponding to the Trading System and restore the original file in the \\Plugins\\Trading-Systems folder as if it was a backup: drag the file and drop it on the Design Space!",
+            "updated": 1615995483240
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-041-tutorial-step-placing-plugins.json

@@ -13,18 +13,18 @@
     "paragraphs": [
         {
             "style": "Callout",
-            "text": "Let's give it a shot! Select Add Missing Trading Systems in the Plugin Trading Systems node! Confirm with a second click...",
-            "updated": 1615926026799
+            "text": "Let's give it a shot! Select Add Missing Trading Systems in the Plugin Trading Systems node!",
+            "updated": 1615926961650
         },
         {
             "style": "Text",
-            "text": "That's it! The rest of the plugins available in the Trading-Systems folder are added as Plugin File nodes! You may delete the Plugin File nodes of the trading systems you don't need and keep the ones you need!",
-            "updated": 1615925783068
+            "text": "New Plugin File nodes are created for every plugin in the \\Plugins\\Trading-Systems folder! You may delete the Plugin File nodes you don't need and keep the ones you do need! Now you may pin the Plugin File Position node where you wish to place the actual plugin data structure!",
+            "updated": 1615927372538
         },
         {
             "style": "Success",
-            "text": "Now you may use the Plugin File Position node to place the plugin in the desired position!",
-            "updated": 1615925560412
+            "text": "Plugins will be added the next time you load the workspace! If you wish to test it, refresh!",
+            "updated": 1615978260752
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-042-tutorial-step-non-persistence-of-changes.json

@@ -0,0 +1,25 @@
+{
+    "tutorial": "Basic Education",
+    "pageNumber": "42",
+    "type": "Tutorial Step - Non-Persistence of Changes",
+    "definition": {
+        "text": "Remember I said that the plugin file is loaded every time the workspace is loaded? This feature has an immediate consequence...",
+        "icon": {
+            "name": "bullet-error",
+            "project": "Superalgos"
+        },
+        "updated": 1615978752612
+    },
+    "paragraphs": [
+        {
+            "style": "Warning",
+            "text": "Hierarchies included in the workspace as plugins are not saved at the workspace level. As such, changes made in those hierarchies do not persist. If you wish to modify a plugin and keep working with the modified version in the future, you must either clone or backup the plugin and work on the resulting copy instead.",
+            "updated": 1615978808209
+        },
+        {
+            "style": "Success",
+            "text": "I will go through some specific use cases in the next few steps!",
+            "updated": 1615978913703
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-044-tutorial-step-improving-a-plugin.json

@@ -0,0 +1,25 @@
+{
+    "tutorial": "Basic Education",
+    "pageNumber": "44",
+    "type": "Tutorial Step - Improving a Plugin",
+    "definition": {
+        "text": "Let's say you are a developer and are testing a new exchange. You wish to modify the Sensor Bot to introduce a new feature or param.",
+        "icon": {
+            "name": "sensor-bot",
+            "project": "Superalgos"
+        },
+        "updated": 1615996858987
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The Sensor Bot is part of the Masters Data Mine, which is usually included as a plugin in most plugin workspaces. In such a case, you must proceed like in the previous case: delete the Plugin File node corresponding to the Masters data mine and restore the data mine file from the Plugins\\Data-Mines folder as if it was a backup.",
+            "updated": 1615997651482
+        },
+        {
+            "style": "Success",
+            "text": "Once you finish, take a backup of the modified Masters Data Mine node and use the backup file to replace the Masters plugin file! Make sure you give it the same name! Then, submit a PR to contribute the improvements on the bot!",
+            "updated": 1615998024660
+        }
+    ]
+}