diff --git a/Projects/Superalgos/Schemas/Docs-Concepts/indicator-bot.json b/Projects/Superalgos/Schemas/Docs-Concepts/indicator-bot.json new file mode 100644 index 000000000..591780fb5 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Concepts/indicator-bot.json @@ -0,0 +1,13 @@ +{ + "type": "Indicator Bot", + "definition": { + "text": "An indicator bot is an algorithm that processes information that other bots have generated, and produces elaborate datasets for others to consume.", + "updated": 1609614405833 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/data-mine-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/data-mine-tasks.json index c9dd2b2c0..009ef02ea 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/data-mine-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/data-mine-tasks.json @@ -16,25 +16,9 @@ "style": "Block", "text": "Configuring" }, - { - "style": "Title", - "text": "Configuring Data Mine Tasks" - }, - { - "style": "Text", - "text": "Select Configure on the menu to access the configuration." - }, { "style": "Block", "text": "Running" - }, - { - "style": "Title", - "text": "Running Data Mine Tasks" - }, - { - "style": "Text", - "text": "Select Run All Task Managers or Stop All Task Managers on the menu to start and stop all tasks under this node." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/data-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/data-tasks.json index 7ca5dc01a..8ad8cd928 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/data-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/data-tasks.json @@ -3,7 +3,31 @@ "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "Having access to quality information is a crucial element of trading. For that reason, Superalgos strives to give users full control over how, where, and when data is processed. You will use this section of the network hierarchy to exert that control.", + "updated": 1609613582225 + }, + { + "style": "Text", + "text": "Data mining is done through tasks running instances of sensor and indicator bots. The data structure under this node allows organizing the data mining operation by project, exchange, market, and data mine.", + "updated": 1609618336656 + }, + { + "style": "Text", + "text": "The setup of the data mining operation may be done using the Install Market function of the market you wish to install as defined in the Crypto Ecosystem hierarchy under the exchange markets node.", + "updated": 1609618361260 + }, + { + "style": "Text", + "text": "You may also set up data mining tasks by using the different functions in this section of the hierarchy, starting with the options in the menu of this node. This route offers finer control over what tasks you set up, and how." + }, + { + "style": "Important", + "text": "Deleting this node causes market install and uninstall scripts to stop working, even if the node is recreated after being deleted.", + "updated": 1609618388438 } - ] + ], + "definition": { + "text": "Data tasks referes to data-mining, that is, the activity of processing data. You need to process data to feed charts, and so that your trading systems may make decisions based on quality information.", + "updated": 1609618235002 + } } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-data-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-data-tasks.json index 27e54c5b5..29380a04a 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-data-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-data-tasks.json @@ -19,14 +19,6 @@ { "style": "Block", "text": "Running" - }, - { - "style": "Title", - "text": "Running Exchange Data Tasks" - }, - { - "style": "Text", - "text": "Select Run All Market Data Tasks or Stop All Market Data Tasks on the menu to start and stop all tasks under this node." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/indicator-bot-instance.json b/Projects/Superalgos/Schemas/Docs-Nodes/indicator-bot-instance.json index 71beb604d..6592e2506 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/indicator-bot-instance.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/indicator-bot-instance.json @@ -1,7 +1,8 @@ { "type": "Indicator Bot Instance", "definition": { - "text": "An indicator bot instance is a reference to an indicator bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products." + "text": "An indicator bot instance is a reference to an Indicator Bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products.", + "updated": 1609617888057 }, "paragraphs": [ { @@ -10,22 +11,19 @@ }, { "style": "Text", - "text": "{{site.data.concepts.indicator_bot}}" + "text": "" }, { "style": "Text", - "text": "The indicator bot instance holds no definitions as to what the bot does. Instead, its processes instances reference the process definitions in the corresponding data mine. That is how the indicator bot instance obtains the information of what it needs to do once it is run." + "text": "The indicator bot instance holds no definitions as to what the bot does. Instead, its processes instances reference the process definitions in the corresponding Data Mine. That is how the indicator bot instance obtains the information of what it needs to do once it is run.", + "updated": 1609617815818 }, { "style": "Block", "text": "Running" }, { - "style": "Title", - "text": "Running Indicator Bot Instance" - }, - { - "style": "Text", + "style": "Note", "text": "You do not start or stop an indicator bot instance directly. Instead, you start or stop the corresponding task." } ] diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/market-data-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/market-data-tasks.json index 6a794635f..2e6b4bd7e 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/market-data-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/market-data-tasks.json @@ -19,14 +19,6 @@ { "style": "Block", "text": "Running" - }, - { - "style": "Title", - "text": "Running Market Data Tasks" - }, - { - "style": "Text", - "text": "Select Run All Data Mine Tasks or Stop All Data Mine Tasks on the menu to start and stop all tasks under this node." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/project-data-tasks.json b/Projects/Superalgos/Schemas/Docs-Nodes/project-data-tasks.json index c55bff55f..a6c01a548 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/project-data-tasks.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/project-data-tasks.json @@ -5,5 +5,9 @@ "style": "Text", "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." } - ] + ], + "definition": { + "text": "The Project Data Tasks node is an organizational device grouping all Data Tasks corresponding to the same project.", + "updated": 1609618469820 + } } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/sensor-bot-instance.json b/Projects/Superalgos/Schemas/Docs-Nodes/sensor-bot-instance.json index 4e23bcc46..547e2b933 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/sensor-bot-instance.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/sensor-bot-instance.json @@ -1,17 +1,14 @@ { "type": "Sensor Bot Instance", "definition": { - "text": "A sensor bot instance is a reference to a sensor bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products." + "text": "A sensor bot instance is a reference to a Sensor Bot as defined in a data mine. The instance of the bot runs the defined processes and generates the defined data products.", + "updated": 1609617856257 }, "paragraphs": [ { "style": "Block", "text": "Content" }, - { - "style": "Text", - "text": "{{site.data.concepts.sensor_bot}}" - }, { "style": "Text", "text": "The sensor bot instance holds no definitions as to what the bot does. Instead, its process instance references a process definition in the corresponding data mine. That is how the sensor bot instance obtains the information regarding what it needs to do once it is run." @@ -22,27 +19,17 @@ }, { "style": "Title", - "text": "Configuring Sensor Bot Instance" + "text": "Sensor Bot Instance Configuration", + "updated": 1609613944104 }, { - "style": "Text", - "text": "Select Configure Sensor Bot Instance on the menu to access the configuration." + "style": "Subtitle", + "text": "Properties" }, { - "style": "Text", - "text": " {" - }, - { - "style": "Text", - "text": " \"startDate\": \"2020-01-01\"" - }, - { - "style": "Text", - "text": " }" - }, - { - "style": "Text", - "text": " startDate is the desired starting date* of the data product the sensor bot instance builds, in the YYYY-MM-DD format. The sensor bot instance queries its data source for data starting on the configured startDate." + "style": "List", + "text": "startDate is the desired starting date of the data product the sensor bot instance builds, in the YYYY-MM-DD format. The sensor bot instance queries its data source for data starting on the configured startDate.", + "updated": 1609614002529 }, { "style": "Text", @@ -50,22 +37,16 @@ }, { "style": "Text", - "text": " * In the case the startDate is changed after the sensor bot has started building a data product, either for an earlier or later date, the sensor re-evaluates the feasibility of starting at the new date. The actual date may or may not change; regardless, the sensor bot discards the existing data product and starts over from the newly discovered date. In other words, if the startDate is changed, the sensor bot starts over." + "text": "In the case the startDate is changed after the sensor bot has started building a data product, either for an earlier or later date, the sensor re-evaluates the feasibility of starting at the new date. The actual date may or may not change; regardless, the sensor bot discards the existing data product and starts over from the newly discovered date. In other words, if the startDate is changed, the sensor bot starts over.", + "updated": 1609614011955 }, { - "style": "Text", - "text": " * Notice that the above starts a chain reaction among all indicator bots that have a data dependency with the sensor bot's output dataset. Also, if the actual date ends up changing, all indicators that determine the starting date of the market by looking at the date discovered by the sensor bot have to discard their existing data products and start over from the new date." + "style": "Note", + "text": "Notice that the above starts a chain reaction among all indicator bots that have a data dependency with the sensor bot's output dataset. Also, if the actual date ends up changing, all indicators that determine the starting date of the market by looking at the date discovered by the sensor bot have to discard their existing data products and start over from the new date.", + "updated": 1609614020847 }, { - "style": "Block", - "text": "Running" - }, - { - "style": "Title", - "text": "Running Sensor Bot Instance" - }, - { - "style": "Text", + "style": "Note", "text": "You do not start or stop a sensor bot instance directly. Instead, you start or stop the corresponding task." } ] diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/sensor-process-instance.json b/Projects/Superalgos/Schemas/Docs-Nodes/sensor-process-instance.json index 0b268435f..b6408b421 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/sensor-process-instance.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/sensor-process-instance.json @@ -17,11 +17,7 @@ "text": "Running" }, { - "style": "Title", - "text": "Running Sensor Process Instance" - }, - { - "style": "Text", + "style": "Note", "text": "You do not start or stop a sensor process instance directly. Instead, you start or stop the corresponding task." } ] diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/task-manager.json b/Projects/Superalgos/Schemas/Docs-Nodes/task-manager.json index 3ea2b6c82..78b32dc92 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/task-manager.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/task-manager.json @@ -17,20 +17,13 @@ "text": "For example, you may set up a task manager to handle tasks related to a particular set of indicators used with a certain strategy. Or, for example, to organize multiple backtesting sessions." }, { - "style": "Text", - "text": "{% include tip.html content=\"The key aspect of a task manager is that it allows starting and stopping all tasks at once.\" %}" + "style": "Success", + "text": "The key aspect of a task manager is that it allows starting and stopping all tasks at once.", + "updated": 1609613698128 }, { "style": "Block", "text": "Running" - }, - { - "style": "Title", - "text": "Running Task Manager" - }, - { - "style": "Text", - "text": "Select Run All Tasks or Stop All Tasks on the menu to start and stop all tasks respectively." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/task.json b/Projects/Superalgos/Schemas/Docs-Nodes/task.json index ddb573cfb..5aeda2c4f 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/task.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/task.json @@ -12,21 +12,14 @@ "style": "Text", "text": "Each task controls a single bot. A bot instance running on its own task is independent from other bots at the operating system level, thus, may not be affected by errors ocurring on those other bots." }, + { + "style": "Text", + "text": "When a task is started, the process instance of the bot instance attached to the task is started. Also, a visual indication that both the task and the process instance are running appear surrounding the corresponding nodes, in the form of a progress ring.", + "updated": 1609613913124 + }, { "style": "Block", "text": "Running" - }, - { - "style": "Title", - "text": "Running Task" - }, - { - "style": "Text", - "text": "Select Run on the menu to start a task. When a task is started, the process instance of the bot instance attached to the task is started. Also, a visual indication that both the task and the process instance are running appear surrounding the corresponding nodes, in the form of a progress ring." - }, - { - "style": "Text", - "text": "To stop a task, select Stop on the menu." } ] } \ No newline at end of file