Merge pull request #367 from julian-molina/develop

Develop
2021-01-14 11:06:38 +01:00
commit 89fa434981
@@ -7,7 +7,8 @@
            "project": "Superalgos",
            "name": "bullet-warning"
        },
-        "text": "When running the frontend, we highly recommend using Chrome!! We are not testing on any other browsers!"
+        "text": "When running the frontend, we highly recommend using Chrome! We are not testing on any other browsers!",
+        "updated": 1610612226890
    },
    "paragraphs": [
        {
@@ -16,7 +16,8 @@
        },
        {
            "style": "List",
-            "text": "Open the Network Node menu and click Configure on the top-right corner."
+            "text": "Click Configure on the top-right corner of the  Network Node menu.",
+            "updated": 1610612485562
        },
        {
            "style": "List",
@@ -20,8 +20,8 @@
        },
        {
            "style": "List",
-            "text": "1. Open the configuration and change the codeName to binanceus.",
-            "updated": 1610537934323
+            "text": "1. Open the configuration and change the codeName to binanceus. Move the mouse pointer out of the configuration bubble and it will close and save automatically.",
+            "updated": 1610612932151
        },
        {
            "style": "List",
@@ -20,7 +20,8 @@
        },
        {
            "style": "Text",
-            "text": "I won't tell you! You'll find out soon... be patient! It should take no longer than 3 to 5 minutes to extract the data from Binance. Fine! Click Next for a quick hint!"
+            "text": "I won't tell you! You'll find out soon.   .   . be patient! It should take no longer than 3 to 5 minutes to extract the data from Binance, or a bit longer, depending on your hardware. Can't wait? Fine! Click Next for a quick hint!",
+            "updated": 1610613730092
        }
    ]
 }
@@ -16,7 +16,12 @@
        },
        {
            "style": "Text",
-            "text": "Easy, right? Great! <br/><br/>However, the design space is a huge place and I wouldn't want you to get tendinitis dragging your way around like this. I'll teach you a couple more tricks in the next couple of steps."
+            "text": "Easy, right? Great! However, the design space is a huge place and I wouldn't want you to get tendinitis dragging your way around like this.",
+            "updated": 1610613840200
+        },
+        {
+            "style": "Success",
+            "text": "I'll teach you a couple more tricks in the next couple of steps."
        }
    ]
 }
@@ -11,17 +11,19 @@
    },
    "paragraphs": [
        {
-            "style": "Text",
-            "text": "Here's the trick:"
+            "style": "Callout",
+            "text": "Regular folks may use the Ctrl key plus arrow keys:  ←  →  ↑  ↓",
+            "updated": 1610614017276
        },
        {
-            "style": "Callout",
-            "text": "Regular folks may use the Ctrl key plus arrow keys: ← → ↑ ↓"
+            "style": "Note",
+            "text": "Notice that keeping the keys pressed makes you fly!",
+            "updated": 1610614056593
        },
        {
            "style": "Success",
-            "text": "Of course Mac fanboys and fangirls must replace Ctrl with Cmd",
-            "updated": 1610134856371
+            "text": "Of course Mac fanboys and girls must replace Ctrl with Cmd",
+            "updated": 1610614224444
        }
    ]
 }
@@ -24,15 +24,13 @@
        },
        {
            "style": "List",
-            "text": "Adding: describes how to add the node."
+            "text": "Configuration: some node may have one.",
+            "updated": 1610614516774
        },
        {
            "style": "List",
-            "text": "Configure: goes through the node's configuration."
-        },
-        {
-            "style": "List",
-            "text": "Start: for nodes that may be started or stopped."
+            "text": "Technical: the rest of the infor is usually of a technical nature, oriented to developers.",
+            "updated": 1610614574015
        },
        {
            "style": "Callout",
@@ -12,8 +12,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "As soon as you start using the system, the workspace is saved every minute. It is also saved before closing the browser or browser tab, and you may save it manually too using the Ctrl + Shift + Key-S keys.",
-            "updated": 1610134881062
+            "text": "As soon as you start using the system, the workspace is saved every minute. It is also saved before closing the browser or browser tab, and you may save it manually using the Ctrl + Shift + Key-S",
+            "updated": 1610614718976
        },
        {
            "style": "Callout",
@@ -12,7 +12,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "Buy now you've learned about six different devices that you may use to control each bot in your data mining operation. At the highest level, the Data Tasks node controls all data mining bots in the Network Node."
+            "text": "By now you've learned about six different devices that you may use to control each bot in your data mining operation. At the highest level, the Data Tasks node controls all data mining bots in the Network Node.",
+            "updated": 1610614923203
        },
        {
            "style": "Callout",
@@ -20,7 +21,8 @@
        },
        {
            "style": "Text",
-            "text": "At the lowest level, an individual task controls a single bot. The nodes in between are organizational nodes that help keep the operation orderly, and allow granular control over the different sections."
+            "text": "At the lowest level, an individual Task controls a single bot. The nodes in between are organizational nodes that help keep the operation in order, and allow granular control over the different sections.",
+            "updated": 1610614976513
        }
    ]
 }
@@ -12,15 +12,18 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "There are two main reasons to run a data mining op:"
+            "text": "There are two main reasons to run Data Tasks:",
+            "updated": 1610616990837
        },
        {
            "style": "List",
-            "text": "To process historic data. You may want to process a datetime range of any given Market to run a Backtesting Session, or to process new indicators."
+            "text": "To process historic data: You may want to process a datetime range of any given Market to run a Backtesting Session, or to process new indicators.",
+            "updated": 1610617009486
        },
        {
            "style": "List",
-            "text": "To run a live session. Live sessions (Paper Trading Session, Forward Testing Session, and Live Trading Session) need a live market feed."
+            "text": "To run a live session: Live sessions (Paper Trading Session, Forward Testing Session, and Live Trading Session) need a live market feed.",
+            "updated": 1610617132164
        },
        {
            "style": "Callout",
@@ -0,0 +1,21 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "7.5",
+    "type": "Tutorial Step - About Small Hardware",
+    "definition": {
+        "text": "While minimalist hardware like the Raspberry Pi can handle the Superalgos Client to run both data and trading tasks, some may be too small for active work!",
+        "updated": 1610615755927
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The core idea behind running the client in small physical or virtual hardware is to maximize cost efficiency in production deployments. In such contexts, the UI is used to a minimum.",
+            "updated": 1610616659750
+        },
+        {
+            "style": "Success",
+            "text": "If you notice your small hardware is too slow during this tutorial, you may want to consider installing in regular hardware until you learn Superalgos, build your first strategies, and are ready to deploy. Otherwise, it may be frustrating.",
+            "updated": 1610616740275
+        }
+    ]
+}
@@ -601,18 +601,13 @@ function newSuperalgosUtilitiesDocs() {
        const MAX_NUMBER_OF_WORDS = 10
        text = text.trim()
        let cleanText = text.replace(/'/g, ' AMPERSAND ') // scaping ampersands, separating them from other words
-            .replaceAll(':', ' :')
-            .replaceAll(',', ' ,')
-            .replaceAll('.', ' .')
-            .replaceAll('!', ' !')
-        let allWords = cleanText.split(' ')
-        let words = []
-        for (let i = 0; i < allWords.length; i++) {
-            let word = allWords[i]
-            if (word !== "") {
-                words.push(word)
-            }
-        }
+            .replaceAll('<', ' < ')
+            .replaceAll('>', ' > ')
+            .replaceAll(':', ' : ')
+            .replaceAll(',', ' , ')
+            .replaceAll('.', ' . ')
+            .replaceAll('!', ' ! ')
+        let words = cleanText.split(' ')
        let taggedText = ''
        for (let i = 0; i < words.length; i++) {

@@ -622,7 +617,7 @@ function newSuperalgosUtilitiesDocs() {

            for (let j = 0; j < MAX_NUMBER_OF_WORDS; j++) {
                let word = words[i + j]
-                if (word === "") { word = " " }
+                if (word === "" ) { word = " "}
                if (word !== undefined) {
                    if (phrase === '') {
                        phrase = word
@@ -671,10 +666,12 @@ function newSuperalgosUtilitiesDocs() {
            }
        }
        taggedText = taggedText.replaceAll(' AMPERSAND ', '\'')
-            .replaceAll(' :', ':')
-            .replaceAll(' .', '.')
-            .replaceAll(' ,', ',')
-            .replaceAll(' !', '!')
+            .replaceAll(' < ', '<')
+            .replaceAll(' > ', '>')
+            .replaceAll(' : ', ':')
+            .replaceAll(' . ', '.')
+            .replaceAll(' , ', ',')
+            .replaceAll(' ! ', '!')
            .replaceAll('  ', ' ')
        return taggedText
    }
@@ -1,6 +0,0 @@
-[1129/182047.011:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)
-[0105/141830.476:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)
-[0113/171643.763:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)
-[0113/181816.824:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)
-[0113/184940.841:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)
-[0113/191144.811:ERROR:directory_reader_win.cc(43)] FindFirstFile: The system cannot find the path specified. (0x3)