Welcome tutorial wip
This commit is contained in:
Julian Molina committed
1 parent
baa5b0c0f0
commit
e13139c5e7
18 files changed
+201
-29
No files matched your search
@@ -2,3 +2,5 @@ Data-Storage
|
||||
Log-Files
|
||||
My-Workspaces
|
||||
debug.log
|
||||
|
||||
*.db
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 211 KiB |
+4
-2
@@ -7,7 +7,8 @@
|
||||
"project": "Superalgos",
|
||||
"name": "exchange-account-key"
|
||||
},
|
||||
"text": "This is where you configure your Exchange Account Key for the Lightning Strike Live Trading Session."
|
||||
"text": "This is where you configure your Exchange Account Key for the Live Trading Session of the Lightning Strike Trading System.",
|
||||
"updated": 1610817577376
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
@@ -20,7 +21,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "In the future, when you get to run multiple live sessions at the same time, you will need to set up one Exchange Account Key per session. This is a requirement in most exchanges."
|
||||
"text": "The Exchange Account Key is stored in the workspace file. It is used to authenticate with the exchange when Trading Bot has to deal with an order. It is never sent or stored anywhere else.",
|
||||
"updated": 1610817739939
|
||||
}
|
||||
]
|
||||
}
|
||||
+7
-2
@@ -28,8 +28,13 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Let's work on a practical example that involves the two! I'll set up the next few steps with a little story... I hope you like the idea!",
|
||||
"updated": 1610713219293
|
||||
"text": "Let's work on a practical example that involves the two! I'll teach you how to edit the docs, and how to contribute, using a couple of commands!",
|
||||
"updated": 1610820646564
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "I'll set up the next few steps with a little story... I hope you like the idea!",
|
||||
"updated": 1610820358700
|
||||
}
|
||||
]
|
||||
}
|
||||
+6
-7
@@ -13,18 +13,17 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "List",
|
||||
"text": "How can Superalgos be free? What's the catch?",
|
||||
"updated": 1610714200780
|
||||
"text": "How can Superalgos be free? What's the catch? We get those questions often! The story goes...",
|
||||
"updated": 1610822099878
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "We get those questions often! The story is...",
|
||||
"updated": 1610714454438
|
||||
"style": "Callout",
|
||||
"text": "Superalgos started with a group of friends joining forces to automate their crypto trading. They soon realized that to compete with top market players a huge software infrastructure was required.",
|
||||
"updated": 1610822256042
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Superalgos started with a group of friends joining forces to automate their crypto trading. They realized early on that to compete with top market players on a level field, a huge software infrastructure was required. The system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team in a reasonable timeframe.",
|
||||
"updated": 1610719794658
|
||||
"text": "The system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team in a reasonable timeframe."
|
||||
}
|
||||
]
|
||||
}
|
||||
+4
-3
@@ -18,12 +18,13 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You just spent an hour or two discovering Superalgos. We want to have your first impression. We want to know what you think! And we want your initial feedback to be the first of many contributions to the project."
|
||||
"text": "You just spent an hour or two discovering Superalgos. We want to have your first impression, fresh from the recent experience! And we want your initial feedback to be the first of many contributions to the project.",
|
||||
"updated": 1610822389227
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "You don't need to be a star programmer or professional trader to contribute. Every user is expected to give back!",
|
||||
"updated": 1610715439365
|
||||
"text": "You don't need to be a star programmer or professional trader to contribute. Every user is expected to give back! I'll tell you how!",
|
||||
"updated": 1610822419407
|
||||
}
|
||||
]
|
||||
}
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "In short, everything that adds value!",
|
||||
"updated": 1610716879897
|
||||
"text": "In short, everything that adds value is good!",
|
||||
"updated": 1610822442723
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
|
||||
+2
-2
@@ -3,8 +3,8 @@
|
||||
"pageNumber": "115",
|
||||
"type": "Tutorial Step - What About Free Riders?",
|
||||
"definition": {
|
||||
"text": "Free riders are a problem, but—for the time being—we choose to assume goodwill! The ball is on your side of the court!",
|
||||
"updated": 1610718496947,
|
||||
"text": "Free riders are a problem, but we choose to assume goodwill! The ball is on your side of the court!",
|
||||
"updated": 1610822537009,
|
||||
"icon": {
|
||||
"name": "bullet-error",
|
||||
"project": "Superalgos"
|
||||
|
||||
+6
-6
@@ -3,8 +3,8 @@
|
||||
"pageNumber": "116",
|
||||
"type": "Tutorial Step - Let's Add Your Review!",
|
||||
"definition": {
|
||||
"text": "In this step, you are going to run your first command to create a review page! This page will be yours to edit in the future too!",
|
||||
"updated": 1610720363593,
|
||||
"text": "In this step, you are going to run your first command to create a review page! This page will be yours to edit in the future!",
|
||||
"updated": 1610822585419,
|
||||
"icon": {
|
||||
"name": "expand",
|
||||
"project": "Superalgos"
|
||||
@@ -22,8 +22,8 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "FIRST: Copy the above command",
|
||||
"updated": 1610721087742
|
||||
"text": "FIRST: Copy the above command.",
|
||||
"updated": 1610822613784
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
@@ -32,8 +32,8 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "THIRD: Replace YOUR REVIEW TITLE with a meaningful title for your review.",
|
||||
"updated": 1610721106177
|
||||
"text": "THIRD: Replace YOUR REVIEW TITLE with a meaningful title. Review titles must be unique!",
|
||||
"updated": 1610822662803
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
|
||||
+2
-1
@@ -23,7 +23,8 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "To exit edit mode, click the Escape key."
|
||||
"text": "To exit edit mode, hit the Escape key.",
|
||||
"updated": 1610822743193
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Each paragraph you write is stored at the level of the browser's session as soon as you exit Edit mode. However, to save the page on disk and avoid losing work on an eventual browser crash, run this command:",
|
||||
"updated": 1610737846767
|
||||
"text": "Each paragraph you write is stored at the level of the browser session as soon as you exit Edit mode. However, to save the page on disk and avoid losing work on an eventual browser crash, run this command:",
|
||||
"updated": 1610822788853
|
||||
},
|
||||
{
|
||||
"style": "Javascript",
|
||||
|
||||
+2
-2
@@ -3,12 +3,12 @@
|
||||
"pageNumber": "120",
|
||||
"type": "Tutorial Step - Get Ready to Push!",
|
||||
"definition": {
|
||||
"text": "Amazing! You learned to add a page to the Docs, edit it, and save it! Now you've got to make it transcend your PC and contribute it to Superalgos!",
|
||||
"text": "Amazing! You learned to add a page to the Docs, edit it, and save it! Now you've got to make it transcend your PC, and contribute it to Superalgos!",
|
||||
"icon": {
|
||||
"name": "github",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610738103790
|
||||
"updated": 1610791858248
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "121",
|
||||
"type": "Tutorial Step - Translation for Mere Mortals",
|
||||
"definition": {
|
||||
"text": "If you are not a developer or are not familiar with Git or GitHub, the previous step probably sounded like gibberish! I know!",
|
||||
"icon": {
|
||||
"name": "github",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610794461181
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Git is an open-source version control system designed to handle collaboration. It's an industry standard.",
|
||||
"updated": 1610794687324
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "The previous step details the techinical steps required for the collaboration to work, meeting some basic norms so that your work doesn't mess up other people's work!"
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "If you do understand Git, you are always free to decide what workflow is best for you!",
|
||||
"updated": 1610792704217
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "122",
|
||||
"type": "Tutorial Step - GitHub.com Authentication",
|
||||
"definition": {
|
||||
"text": "For the app.contribute command to work, you need to authenticate at two different levels. We'll deal with GiHub.com first!",
|
||||
"icon": {
|
||||
"name": "github-api",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610799914806
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "You need to authenticate at GitHub.com for the Client to create the Pull Request on your behalf. To do that, you will create a Personal Access token in the following URL:",
|
||||
"updated": 1610799974046
|
||||
},
|
||||
{
|
||||
"style": "Link",
|
||||
"text": "GitHub.com Personal Access Token->https://github.com/settings/tokens/new",
|
||||
"updated": 1610813456957
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Click the link and follow the instructions below! Check the clip on the next step for clarity...",
|
||||
"updated": 1610812678018
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "I suggest you name the token after Superalgos so that you may recognize it later on, and make sure you check the repo checkbox to define the scope of the token.",
|
||||
"updated": 1610812554380
|
||||
}
|
||||
]
|
||||
}
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "123",
|
||||
"type": "Tutorial Step - GitHub.com Auth Clip",
|
||||
"definition": {
|
||||
"text": "Write here a summary for this tutorial page."
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Gif",
|
||||
"text": "GIFs/Superalgos/Tutorials/github-personal-access-token.gif",
|
||||
"updated": 1610813170120
|
||||
}
|
||||
]
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "124",
|
||||
"type": "Tutorial Step - Set Up the Token!",
|
||||
"definition": {
|
||||
"text": "After you hit the Generate Token button, you'll get your precious token! Don't leave the page as you won't ever see it again!",
|
||||
"icon": {
|
||||
"name": "github-api",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610815737032
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Copy the token! Open the Github API node configuration, and paste it between the double quotes of the token parameter. Fill in the username parameter with your GitHub.com user.",
|
||||
"updated": 1610824281449
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Superalgos stores the token in the workspace file, just like your Exchange Account Key. The token is used to autheticate with GitHub.com's API to create the Pull Request. It is never sent or stored anywhere else.",
|
||||
"updated": 1610817098653
|
||||
}
|
||||
]
|
||||
}
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "125",
|
||||
"type": "Tutorial Step - A Note On Keys and Tokens!",
|
||||
"definition": {
|
||||
"text": "Let me make a quick pause to point out something important regarding the safety of your keys and tokens...",
|
||||
"icon": {
|
||||
"name": "exchange-account-key",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610818135402
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Superalgos stores the workspace file that contains your keys and tokens in the JSON format, unencrypted. In this state, this crucial information is as safe as your computer may be.",
|
||||
"updated": 1610818293009
|
||||
},
|
||||
{
|
||||
"style": "Warning",
|
||||
"text": "ever share your workspace file AS IS. To share a workspace, use the Share button on the menu. It creates a share-safe copy of the workspace, stripped of sensitive information by removing the APIs hierarchy and the Exchange Accounts section of the Crypto Exchange node.",
|
||||
"updated": 1610824651241
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"tutorial": "Welcome to Superalgos!",
|
||||
"pageNumber": "126",
|
||||
"type": "Tutorial Step - Contributable files?",
|
||||
"definition": {
|
||||
"text": "Most files within the Superalgos folder are subject to be modified and contributed to the project! That includes code, images, documentation, etc.",
|
||||
"icon": {
|
||||
"name": "dataset",
|
||||
"project": "Superalgos"
|
||||
},
|
||||
"updated": 1610823292611
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "The one folder that is exempt from being contributed is the My-Workspaces folder.",
|
||||
"updated": 1610823384700
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "Do not use the Superalgos folder to store personal stuff or files that are not meant to be part of the Superalgos software! Anything that you include in the Superalgos folder (save for the noted exempted folder) is subject to be committed as a change, sent to your fork on GitHub.com, and included in a Pull Request, both publicly accessible!",
|
||||
"updated": 1610823908363
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user