Merge pull request #458 from julian-molina/develop

Contribution: Productivity tools
This commit is contained in:
Julian Molina authored and GitHub committed 2021-01-24 13:23:55 +01:00
commit cb11b3db7d
12 files changed
+307

No files matched your search

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 489 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 602 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 MiB

@@ -0,0 +1,134 @@
{
"topic": "Productivity Tools",
"pageNumber": "1",
"type": "Backups",
"definition": {
"text": "The backup feature is designed to preserve the integrity of references as you would expect when you wish to restore a data structure to a previous state of affairs.",
"updated": 1611489612653
},
"paragraphs": [
{
"style": "Title",
"text": "Introduction",
"updated": 1611489635384
},
{
"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."
},
{
"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."
},
{
"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."
},
{
"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": "Title",
"text": "Outgoing References"
},
{
"style": "Callout",
"text": "Outgoing references are kept no matter if the original structure of nodes still exists or not."
},
{
"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."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/backups-01.gif",
"updated": 1611489923510
},
{
"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."
},
{
"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": "Title",
"text": "Incoming References"
},
{
"style": "Callout",
"text": "Incoming references are restored only when the original structure of nodes is deleted before restoring the backup."
},
{
"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."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/backups-02.gif",
"updated": 1611489956681
},
{
"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."
},
{
"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."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/backups-03.gif",
"updated": 1611489978479
},
{
"style": "Title",
"text": "Internal References"
},
{
"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."
},
{
"style": "Text",
"text": "Let’s see what happens when we restore a backup of a shapes node without deleting the original node first:"
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/backups-04.gif",
"updated": 1611490001325
},
{
"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."
},
{
"style": "Text",
"text": "On the other hand, if the original structure of nodes is deleted before restoring the backup, then the references point to the nodes within the same structure:"
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/backups-05.gif",
"updated": 1611490016934
},
{
"style": "Title",
"text": "Conclusion"
},
{
"style": "Text",
"text": "The backup feature is designed to preserve the integrity of references as you would expect when you wish to restore a data structure to a previous state of affairs."
},
{
"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
},
{
"style": "Text",
"text": ""
}
]
}
@@ -0,0 +1,95 @@
{
"topic": "Productivity Tools",
"pageNumber": "2",
"type": "Clones",
"definition": {
"text": "The clone feature is designed to produce copies of data structures when you need to replicate nodes and expect the copies to behave similarly to the original.",
"updated": 1611490308337
},
"paragraphs": [
{
"style": "Title",
"text": "Introduction",
"updated": 1611490329180
},
{
"style": "Text",
"text": "We will analyze the case of clones under the same lens we analyzed how backups work: we will study how clones treat outgoing, incoming and internal references."
},
{
"style": "Text",
"text": "Unlike with backups, clones behave in the same way independently of the existence of the original structure of nodes in the workspace, therefore, we will not make such distinction in the following paragraphs."
},
{
"style": "Title",
"text": "Outgoing References"
},
{
"style": "Callout",
"text": "Outgoing references are kept intact."
},
{
"style": "Text",
"text": "Pretty much like with backups, a clone preserves outgoing references."
},
{
"style": "Text",
"text": "The same example as with backups apply: cloning a task running a session produces a copy of the task with the trading bot process instance maintaining the reference to the trading bot Multi-Period process, and the session maintaining the reference with the corresponding trading system."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/clones-01.gif",
"updated": 1611490442818
},
{
"style": "Title",
"text": "Incoming References"
},
{
"style": "Callout",
"text": "Incoming references are discarded."
},
{
"style": "Text",
"text": "Let’s go back to the example of a trading system, like we did when exploring backups:"
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/clones-02.gif",
"updated": 1611490471957
},
{
"style": "Text",
"text": "The capture above shows that restoring a clone of a trading system does not restore incoming references, even when the original structure of nodes is deleted before restoration."
},
{
"style": "Title",
"text": "Internal References"
},
{
"style": "Callout",
"text": "Internal references are kept intact."
},
{
"style": "Text",
"text": "Going back to the shapes node example, the capture below shows how restonring a clone keeps internal references intact:"
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/design-space/clones-03.gif",
"updated": 1611490496345
},
{
"style": "Title",
"text": "Conclusion"
},
{
"style": "Text",
"text": "The clone feature is designed to produce copies of data structures when you need to replicate nodes and expect the copies to behave similarly to the original."
},
{
"style": "Text",
"text": ""
}
]
}
@@ -0,0 +1,41 @@
{
"topic": "Productivity Tools",
"pageNumber": "3",
"type": "Shares",
"definition": {
"text": "The share feature works almost the same as the back up feature, but discarding personal information like exchange keys.",
"updated": 1611490590355
},
"paragraphs": [
{
"style": "Text",
"text": "The share feature works almost the same as the back up feature, with the sole difference that shares do not store personal information, like exchange API keys.",
"updated": 1611490600062
},
{
"style": "Text",
"text": "On that note, we will not analyze this feature further, other than reminding the user that it is recommended to develop the habit to only share shares and not backups, to avoid the potential accidental dissemination of exchange keys."
},
{
"style": "Callout",
"text": "On a different note, it is also critical to bring one more issue to your attention regarding sharing work and—what’s more more important— using other people’s work."
},
{
"style": "Text",
"text": "You may have noticed that the system accepts JavaScript code in a multitude of input forms such as configurations, conditions, formulas and more. At this point, there is no restriction to the code that may be used. This is a design feature, as we wish advanced users to be able to use their programing skills to make the most out of the system."
},
{
"style": "Text",
"text": "However, this also means that using workspaces or any other data structure coming from untrusted sources is not free of risks. On the contrary, it may be a high-risk choice, as it is possible to introduce malicious code that may, for example, attempt to steal people’s API keys."
},
{
"style": "Warning",
"text": "Beware of using shared data structures from untrusted sources as they may contain malicious code that could, for example, steal your exchange keys.",
"updated": 1611490613530
},
{
"style": "Text",
"text": ""
}
]
}
@@ -0,0 +1,37 @@
{
"topic": "Productivity Tools",
"pageNumber": "4",
"type": "Screen Capture and Sharing",
"definition": {
"text": "Share you screen with friends and colleagues capturing still images or videos directly from within the frontend.",
"updated": 1611490773902
},
"paragraphs": [
{
"style": "List",
"text": "Hit Ctrl + F8 to capture a static PNG image.",
"updated": 1611490790992
},
{
"style": "List",
"text": "Hit Ctrl + F9 to start capturing a GIF video, and hit the same key combination again to end the capture. Once the capture ends, it takes some time to process the capture and generate the final file."
},
{
"style": "List",
"text": "Hit Ctrl + F10 to start capturing a WEBM video, and hit the same key combination again to end the capture. WEBM videos are processed instantly."
},
{
"style": "Text",
"text": "In all three cases, the browser downloads the resulting file and makes it available in the downloads folder."
},
{
"style": "Note",
"text": "GIF files tend to grow a lot in long captures, but are more universal, thus more devices can display them properly. WEBM files are a lot more efficient, but do not work in Apple and, potentially, other platforms or devices.",
"updated": 1611490891864
},
{
"style": "Text",
"text": ""
}
]
}