Merge pull request #798 from julian-molina/develop

Contribution: Contribute tutorial plugins-docs branch update
2021-04-11 19:02:40 +02:00
commit fd8619f2c3
@@ -1 +1 @@
-{"type":"Workspace","name":"Getting Started","rootNodes":[{"type":"Network","name":"My Network","project":"Superalgos","networkNodes":[{"type":"Network Node","name":"My Computer","config":"{ \n\"host\": \"localhost\", \n\"webPort\": \"34248\", \n\"webSocketsPort\": \"18041\"\n}","project":"Superalgos","dataTasks":{"type":"Data Tasks","name":"New Data Tasks","project":"Superalgos","projectDataTasks":[{"type":"Project Data Tasks","name":"Superalgos","project":"Superalgos","exchangeDataTasks":[{"type":"Exchange Data Tasks","name":"Binance","project":"Superalgos","marketDataTasks":[{"type":"Market Data Tasks","name":"Binance BTC/USDT","project":"Superalgos","dataMineTasks":[{"type":"Data Mine Tasks","name":"Masters","project":"Superalgos","taskManagers":[{"type":"Task Manager","name":"Masters","project":"Superalgos","tasks":[{"type":"Task","name":"Exchange Raw Data","project":"Superalgos","bot":{"type":"Sensor Bot Instance","name":"Exchange Raw Data","config":"{ \n\"startDate\": \"2020-01-01\"\n}","project":"Superalgos","processes":[{"type":"Sensor Process Instance","name":"Exchange Raw Data Historic-OHLCVs","project":"Superalgos","id":"d244c564-4e86-43c7-9796-dc3b6294ec8b","savedPayload":{"position":{"x":23490.023749611923,"y":29239.135911211026},"targetPosition":{"x":23779.801497498644,"y":29316.781624741783},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Historic-OHLCVs","id":"5eb11d6a-022e-4f60-97c4-d6cf90b249dc"}}}],"id":"343313ae-5705-484d-8bf8-aed25ba61cfa","savedPayload":{"position":{"x":23779.801497498644,"y":29316.781624741783},"targetPosition":{"x":24069.579245385365,"y":29394.42733827254},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"a8f38508-1cac-4ab1-815f-d338fc813377","savedPayload":{"position":{"x":24069.579245385365,"y":29394.42733827254},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Candles Volumes","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Candles Volumes","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Market","project":"Superalgos","id":"f0ef12ed-f0fd-4b88-8e15-27cf24265a5f","savedPayload":{"position":{"x":23799.549372136753,"y":28802.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Market","id":"9f683143-a33f-42c1-9fa8-c601f01ee4e1"}}},{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Daily","project":"Superalgos","id":"7c8b312c-09bf-4c59-853f-1592391a9c57","savedPayload":{"position":{"x":24059.356993272086,"y":28652.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Daily","id":"980ceb1d-7be6-454f-90d9-01ba1fd4a65d"}}}],"id":"8d58e84b-d7ef-464f-8079-0ec0887e3da3","savedPayload":{"position":{"x":24059.356993272086,"y":28952.457809532632},"targetPosition":{"x":24209.356993272086,"y":29212.265430667965},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"bf29e3bd-9386-408b-9091-042da0c53e81","savedPayload":{"position":{"x":24209.356993272086,"y":29212.265430667965},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Resistances and Supports","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Resistances and Supports","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Resistances and Supports Multi-Period-Market","project":"Superalgos","id":"a707814e-b81b-4102-9b5b-4e2fe969324f","savedPayload":{"position":{"x":24437.002706802843,"y":28602.739808143135},"targetPosition":{"x":24514.6484203336,"y":28892.517556029856},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"refeLine truncated
+{"type":"Workspace","name":"Getting Started","rootNodes":[{"type":"Network","name":"My Network","project":"Superalgos","networkNodes":[{"type":"Network Node","name":"My Computer","config":"{ \n\"host\": \"localhost\", \n\"webPort\": \"34248\", \n\"webSocketsPort\": \"18041\"\n}","project":"Superalgos","dataTasks":{"type":"Data Tasks","name":"New Data Tasks","project":"Superalgos","projectDataTasks":[{"type":"Project Data Tasks","name":"Superalgos","project":"Superalgos","exchangeDataTasks":[{"type":"Exchange Data Tasks","name":"Binance","project":"Superalgos","marketDataTasks":[{"type":"Market Data Tasks","name":"Binance BTC/USDT","project":"Superalgos","dataMineTasks":[{"type":"Data Mine Tasks","name":"Masters","project":"Superalgos","taskManagers":[{"type":"Task Manager","name":"Masters","project":"Superalgos","tasks":[{"type":"Task","name":"Exchange Raw Data","project":"Superalgos","bot":{"type":"Sensor Bot Instance","name":"Exchange Raw Data","config":"{ \n\"startDate\": \"2020-01-01\"\n}","project":"Superalgos","processes":[{"type":"Sensor Process Instance","name":"Exchange Raw Data Historic-OHLCVs","project":"Superalgos","id":"d244c564-4e86-43c7-9796-dc3b6294ec8b","savedPayload":{"position":{"x":23490.023749611923,"y":29239.135911211026},"targetPosition":{"x":23779.801497498644,"y":29316.781624741783},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Historic-OHLCVs","id":"5eb11d6a-022e-4f60-97c4-d6cf90b249dc"}}}],"id":"343313ae-5705-484d-8bf8-aed25ba61cfa","savedPayload":{"position":{"x":23779.801497498644,"y":29316.781624741783},"targetPosition":{"x":24069.579245385365,"y":29394.42733827254},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"a8f38508-1cac-4ab1-815f-d338fc813377","savedPayload":{"position":{"x":24069.579245385365,"y":29394.42733827254},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Candles Volumes","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Candles Volumes","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Market","project":"Superalgos","id":"f0ef12ed-f0fd-4b88-8e15-27cf24265a5f","savedPayload":{"position":{"x":23799.549372136753,"y":28802.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Market","id":"9f683143-a33f-42c1-9fa8-c601f01ee4e1"}}},{"type":"Indicator Process Instance","name":"Candles Volumes Multi-Period-Daily","project":"Superalgos","id":"7c8b312c-09bf-4c59-853f-1592391a9c57","savedPayload":{"position":{"x":24059.356993272086,"y":28652.457809532632},"targetPosition":{"x":24059.356993272086,"y":28952.457809532632},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"referenceParent":{"type":"Process Definition","name":"Multi-Period-Daily","id":"980ceb1d-7be6-454f-90d9-01ba1fd4a65d"}}}],"id":"8d58e84b-d7ef-464f-8079-0ec0887e3da3","savedPayload":{"position":{"x":24059.356993272086,"y":28952.457809532632},"targetPosition":{"x":24209.356993272086,"y":29212.265430667965},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},"id":"bf29e3bd-9386-408b-9091-042da0c53e81","savedPayload":{"position":{"x":24209.356993272086,"y":29212.265430667965},"targetPosition":{"x":24359.356993272086,"y":29472.073051803298},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false}}},{"type":"Task","name":"Resistances and Supports","project":"Superalgos","bot":{"type":"Indicator Bot Instance","name":"Resistances and Supports","config":"{}","project":"Superalgos","processes":[{"type":"Indicator Process Instance","name":"Resistances and Supports Multi-Period-Market","project":"Superalgos","id":"a707814e-b81b-4102-9b5b-4e2fe969324f","savedPayload":{"position":{"x":24437.002706802843,"y":28602.739808143135},"targetPosition":{"x":24514.6484203336,"y":28892.517556029856},"floatingObject":{"isPinned":false,"isFrozen":false,"isCollapsed":false,"angleToParent":2,"distanceToParent":3,"arrangementStyle":0},"uiObject":{"isRunning":false},"refeLine truncated
@@ -0,0 +1,84 @@
+{
+    "topic": "How To",
+    "pageNumber": "3",
+    "type": "Create the Plugins-Docs Branch in Old Forks",
+    "definition": {
+        "text": "If your Superalgos fork is older than April 6, 2021, you must create the plugin-docs branch before you may switch to that branch! Newer forks already have the branch, so you don't need to follow this guide in that case!",
+        "updated": 1618155549345
+    },
+    "paragraphs": [
+        {
+            "style": "Note",
+            "text": "If you didn't create a fork at all, and cloned or downloaded the Superalgos repository directory instead, you will not be able to send your contributions. If that is the case, you will need to close the app, delete the Superalgos folder, and follow the instructions on the README file to fork the repository.",
+            "updated": 1618158446203
+        },
+        {
+            "style": "Title",
+            "text": "1. Go to Your Fork at Github.com"
+        },
+        {
+            "style": "Text",
+            "text": "Your fork is located in the following URL, replacing USERNAME with your actual Github.com username:"
+        },
+        {
+            "style": "Json",
+            "text": "https://github.com/USERNAME/Superalgos/"
+        },
+        {
+            "style": "Title",
+            "text": "2. Make Sure You Are on the Master Branch",
+            "updated": 1618156383837
+        },
+        {
+            "style": "Text",
+            "text": "Check the branch name in the combo box:",
+            "updated": 1618156395319
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/how-to/create-plugins-docs-branch-01.png",
+            "updated": 1618157385110
+        },
+        {
+            "style": "Title",
+            "text": "3. Click on 'master' and type <code>plugins-docs</code> in the Field",
+            "updated": 1618156956365
+        },
+        {
+            "style": "Important",
+            "text": "Make sure the spelling is exact!"
+        },
+        {
+            "style": "Json",
+            "text": "plugins-docs"
+        },
+        {
+            "style": "Title",
+            "text": "4. Click the <code>Create branch: plugins-docs from 'master'</code> Button",
+            "updated": 1618156987815
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/how-to/create-plugins-docs-branch-02.png",
+            "updated": 1618157499323
+        },
+        {
+            "style": "Text",
+            "text": "You should end up with the confirmation that the new branch has been created.",
+            "updated": 1618157121114
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/how-to/create-plugins-docs-branch-03.png",
+            "updated": 1618157524877
+        },
+        {
+            "style": "Title",
+            "text": "5. That's it!"
+        },
+        {
+            "style": "Success",
+            "text": "Now you may go back to the tutorial!"
+        }
+    ]
+}
@@ -3,8 +3,8 @@
    "pageNumber": 8,
    "type": "Tutorial Step - Switching Branches",
    "definition": {
-        "text": "The master branch in the Superalgos repo features the latest stable version, while the develop branch features the version in development!",
-        "updated": 1616759979604,
+        "text": "Superalgos allows you to switch branches directly from within the app! But, why would you want to switch branches?",
+        "updated": 1618145423371,
        "icon": {
            "name": "github",
            "project": "Superalgos"
@@ -18,13 +18,13 @@
        },
        {
            "style": "Success",
-            "text": "Or you may wish to submit a contribution, which must always be sent to the develop branch!",
-            "updated": 1616760455582
+            "text": "Or you may wish to submit a contribution, like in our case right now! Let's do it!",
+            "updated": 1618145540691
        },
        {
            "style": "Callout",
-            "text": "Scroll down the Docs page to the footer and select Develop as your Contributions Branch! It's the option on the right-hand side, not in the center!",
-            "updated": 1616760852432
+            "text": "Scroll down the Docs page to the footer and select Plugins/Docs as your Contributions Branch! It's the option on the right-hand side, not in the center!",
+            "updated": 1618145561816
        }
    ]
 }
@@ -13,13 +13,18 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "Now it's time to change the Current Branch! When you do that, the app will run a series of Git commands that will download the software from the develop branch of your fork! The current software will be automatically replaced on your disk! For that reason, you will need to close the app after switching, restart, find the tutorial and resume to keep going!",
-            "updated": 1617017990927
+            "text": "Next in line is switching the Current Branch, but we need to run some checks first!",
+            "updated": 1618154759190
        },
        {
-            "style": "Important",
-            "text": "But before you switch branches, let's take a moment to think of the consequences!",
-            "updated": 1617008246622
+            "style": "Callout",
+            "text": "If you forked the Superalgos repo before April 6th, 2021, follow the instructions on this page to create the plugins-docs branch. Otherwise, keep going!",
+            "updated": 1618154888356
+        },
+        {
+            "style": "Text",
+            "text": "When you switch branches, the app will run a series of Git commands that will download the software from the plugins-docs branch of your fork! The current software will be replaced on your disk! For that reason, you will need to close the app after switching. But let's discuss a couple more things before you proceed!",
+            "updated": 1618159009151
        }
    ]
 }
@@ -3,23 +3,23 @@
    "pageNumber": 10,
    "type": "Tutorial Step - Before You Switch",
    "definition": {
-        "text": "There are a few things you should consider every time you switch branches! Let's go through a quick list bfore you proceed!",
+        "text": "There are a few things you should consider every time you switch branches! Let's go through a quick list before you proceed!",
        "icon": {
            "name": "bullet-warning",
            "project": "Superalgos"
        },
-        "updated": 1617018123415
+        "updated": 1618147991903
    },
    "paragraphs": [
        {
            "style": "List",
-            "text": "It may happen that the workspaces or other data structures in the master branch are not compatible with those in the develop branch. ",
-            "updated": 1617017830521
+            "text": "It may happen that the workspaces or other data structures in the master branch are not compatible with those in the other branch.",
+            "updated": 1618158546133
        },
        {
            "style": "List",
-            "text": "If the current workspace is incompatible with the software in the other branch, the workspace may break upon reloading the app. In such a case, you must load a Plugin Workspace of the new branch.",
-            "updated": 1617018153708
+            "text": "If the current workspace is incompatible with the software in the other branch, the workspace may break upon reloading the app. In such a case, load one of the Plugin Workspaces of the new branch.",
+            "updated": 1618158600251
        },
        {
            "style": "List",
@@ -28,8 +28,8 @@
        },
        {
            "style": "Important",
-            "text": "Always check the README file in the develop branch of the repository for any comments on backward compatibility. Before switching branches, it is always good to back up your work!",
-            "updated": 1617017837289
+            "text": "Always check the README file in the branch of the repository you wish to access for any comments on backward compatibility. Before switching branches, back up your work!",
+            "updated": 1618158675366
        }
    ]
 }
@@ -13,8 +13,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "You may have two clones of your fork running from separate folders, one of them in the develop branch.",
-            "updated": 1617018731051
+            "text": "You may have two clones of your fork running from separate folders, each on different branches.",
+            "updated": 1618158812449
        },
        {
            "style": "Note",
@@ -23,8 +23,8 @@
        },
        {
            "style": "Success",
-            "text": "Such a setup allows you to run the stable version for your production tasks, and the version in develop to contribute and test new features!",
-            "updated": 1617018806324
+            "text": "Such a setup allows you to run the stable version for your production tasks, and the version in another branch to contribute and test new features! But you can't run two versions at the same time, unless you change ports! We won't go there now!",
+            "updated": 1618148172616
        }
    ]
 }
@@ -18,8 +18,8 @@
        },
        {
            "style": "List",
-            "text": "Go back to the footer and select Develop as your Current Branch.",
-            "updated": 1617019546125
+            "text": "Go back to the footer and select Plugins/Docs as your Current Branch.",
+            "updated": 1618159168230
        },
        {
            "style": "List",
@@ -3,18 +3,18 @@
    "pageNumber": 13,
    "type": "Tutorial Step - Welcome Back!",
    "definition": {
-        "text": "If you followed my instructions to the letter, you should now be running the software in the develop branch! Awesome!",
+        "text": "If you followed my instructions to the letter, you should now be running the software in the plugins-docs branch! Awesome!",
        "icon": {
            "name": "hits",
            "project": "Superalgos"
        },
-        "updated": 1617007379836
+        "updated": 1618159282200
    },
    "paragraphs": [
        {
            "style": "Text",
-            "text": "The software you are currently running is the version of Superalgos that was at the develop branch the day you forked the project! This is because the process of switching branches downloads the software from your fork and not the upstream repository.",
-            "updated": 1617020053004
+            "text": "The software you are currently running is the version of Superalgos that was at the plugins-docs branch the day you forked the project! This is because the process of switching branches downloads the software from your fork and not the upstream repository.",
+            "updated": 1618159308510
        },
        {
            "style": "Success",
@@ -0,0 +1,33 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "7.5",
+    "type": "Tutorial Step - Repository Branches",
+    "definition": {
+        "text": "The Superalgos repository features three main branches: master, develop, and the one we're looking for, plugins-docs.",
+        "icon": {
+            "name": "github",
+            "project": "Superalgos"
+        },
+        "updated": 1618143614949
+    },
+    "paragraphs": [
+        {
+            "style": "Success",
+            "text": "There may be more, but these are the main!",
+            "updated": 1618143442686
+        },
+        {
+            "style": "List",
+            "text": "Master Branch: Features the stable version of the software. Never submit contributions to this branch!"
+        },
+        {
+            "style": "List",
+            "text": "Develop Branch: Features the version currently in development. Submit contributions of code affecting the codebase.",
+            "updated": 1618143744374
+        },
+        {
+            "style": "List",
+            "text": "Plugins/Docs Branch: Features the version in the master branch plus the latest changes in the Docs and Plugins. Submit contributions of translations, improvements in the Docs, tutorials, and plugins such as data mines, trading systems, and so on!"
+        }
+    ]
+}