Contributing tutorial

2021-03-29 18:21:33 +02:00
1 parent 955cbb128b
commit 3a9575bbb8
@@ -0,0 +1,21 @@
+{
+    "topic": "Contributing to Superalgos",
+    "pageNumber": 1,
+    "type": "How to Contribute to Superalgos",
+    "definition": {
+        "text": "This topic covers the logistics and details of how to contribute different kinds of assets to the project, including a Trading System, a Data Mine, icons, documentation, translations, and so on.",
+        "updated": 1617032255373
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Scan the table of contents below to find the documentation about how to contribute the kind of asset you may have in mind.",
+            "updated": 1617032405931
+        },
+        {
+            "style": "Success",
+            "text": "If there is no explanation about the type of asset you wish to contribute, please reach out to the team in the Superalgos Community Group!",
+            "updated": 1617032427271
+        }
+    ]
+}
@@ -1,6 +1,6 @@
 {
    "topic": "Contributing to Superalgos",
-    "pageNumber": "1",
+    "pageNumber": 2,
    "type": "How to Contribute a Trading System",
    "definition": {
        "text": "To contribute a Trading System, you must provide the trading system file, a clean workspace, and proper documentation.",
@@ -1,6 +1,6 @@
 {
    "topic": "Contributing to Superalgos",
-    "pageNumber": "2",
+    "pageNumber": 3,
    "type": "How to Contribute Icons",
    "definition": {
        "text": "Superalgos' visual interface features hundreds of icons and many more icons are required with each release, as new functionality is rolled out. Designing icons is a great way to leave your mark, as it puts your work directly in front of every user!",
@@ -1,6 +1,6 @@
 {
    "topic": "Contributing to Superalgos",
-    "pageNumber": "3",
+    "pageNumber": 4,
    "type": "How to Contribute to the Docs",
    "definition": {
        "text": "Helping with keeping the Docs up to date, improving the delivery of the information, expanding on explanations, or simply fixing typos and grammar mistakes makes for a better user experience and lowers entry barriers for new users.",
@@ -1,6 +1,6 @@
 {
    "topic": "Contributing to Superalgos",
-    "pageNumber": "4",
+    "pageNumber": 5,
    "type": "How to Contribute Translations",
    "definition": {
        "text": "The Docs are originally written in English. Making Superalgos more accessible is a key endeavor to grow the Community and the user base. Translating tutorials and software documentation into languages other than English is of huge value!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.2",
+    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.3",
+    "pageNumber": 9,
    "type": "Tutorial Step - Now the Current Branch",
    "definition": {
        "text": "If everything went well, you must have got a confirmation that the Contributions Branch was changed! Awesome!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.32",
+    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.34",
+    "pageNumber": 11,
    "type": "Tutorial Step - Double Trouble?",
    "definition": {
        "text": "Many users choose to run the two branches from separate folders! This seems like a sensible solution for active contributors!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.36",
+    "pageNumber": 12,
    "type": "Tutorial Step - Let's Switch Already!",
    "definition": {
        "text": "Now that everything's clear, let's do the switch and get ready for what comes next!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.4",
+    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "7.5",
+    "pageNumber": 14,
    "type": "Tutorial Step - Update the App!",
    "definition": {
        "text": "The App Update Command fetches the latest version of the software from the upstream repository in the Current Branch!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 8,
+    "pageNumber": 15,
    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 9,
+    "pageNumber": 16,
    "type": "Tutorial Step - Did It Work?",
    "definition": {
        "text": "If you didn't mess up the command, you should get a new page with the title you set, an invitation to write a summary, and more instructions below!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "9.2",
+    "pageNumber": 17,
    "type": "Tutorial Step - Breaking Up The Command",
    "definition": {
        "text": "Before you get on with writting your awesome review, let me parse the command so that you understand what you just did!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": "9.4",
+    "pageNumber": 18,
    "type": "Tutorial Step - Editing Crash Course",
    "definition": {
        "text": "I'll give you a few pointers on how to edit the page! Right-click on a paragraph to get the styles menu. The pencil starts edit mode...",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 10,
+    "pageNumber": 19,
    "type": "Tutorial Step - Don't Forget to Sign!",
    "definition": {
        "text": "These comments about your first impressions on Superalgos are your first contribution, and for that we thank you!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 11,
+    "pageNumber": 20,
    "type": "Tutorial Step - Don't Forget to Save!",
    "definition": {
        "text": "Before you get to a novel-length kind of write-up, make sure you save the page every once in a while! No need to risk your prose!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 12,
+    "pageNumber": 21,
    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 13,
+    "pageNumber": 22,
    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 14,
+    "pageNumber": 23,
    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 15,
+    "pageNumber": 24,
    "type": "Tutorial Step - GitHub.com Auth Clip",
    "definition": {
        "text": "Write here a summary for this tutorial page."
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 16,
+    "pageNumber": 25,
    "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!",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 17,
+    "pageNumber": 26,
    "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...",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 18,
+    "pageNumber": 27,
    "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.",
@@ -1,6 +1,6 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 19,
+    "pageNumber": 28,
    "type": "Tutorial Step - Let's Run the Command!",
    "definition": {
        "text": "Let's get on with the task at hand! Copy the command below, paste it on the search/command box, and hit Enter!",
@@ -1,10 +1,10 @@
 {
    "tutorial": "Contribute to Superalgos!",
-    "pageNumber": 20,
+    "pageNumber": 29,
    "type": "Tutorial Step - Congrats and Thank You!",
    "definition": {
-        "text": "This is awesome! You are already helping the project! We are grateful for your first contribution and hope for more to come!",
-        "updated": 1611595200232,
+        "text": "This is awesome! You are already helping the project! We are grateful for your first contribution and hope there's more to come!",
+        "updated": 1617031656299,
        "icon": {
            "name": "docs-success-style",
            "project": "Superalgos"
@@ -0,0 +1,25 @@
+{
+    "tutorial": "Contribute to Superalgos!",
+    "pageNumber": "30",
+    "type": "Tutorial Step - More on Contributions",
+    "definition": {
+        "text": "I can't stress enough how important it is for the project that users contribute whatever they build with Superalgos!",
+        "icon": {
+            "name": "execution-algorithm",
+            "project": "Superalgos"
+        },
+        "updated": 1617033287328
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "If you choose to get involved with the project and the Community, you may participate in the collective effort to make Superalgos better. But even if you are not interested in team work, you will still develop your skills, become a power user, and build many things that may be of use to people coming after you!",
+            "updated": 1617033959946
+        },
+        {
+            "style": "Success",
+            "text": "How to Contribute to Superalgos is the topic that covers the logistics on how to contribute trading systems, data mines, icons, documentation, translations, and so on. Remember: all contributions are incentived with Superalgos tokens!",
+            "updated": 1617034022307
+        }
+    ]
+}
@@ -0,0 +1,29 @@
+{
+    "tutorial": "Contribute to Superalgos!",
+    "pageNumber": "31",
+    "type": "Tutorial Step - A Book on Tutorials",
+    "definition": {
+        "text": "Congratulations! You reached the end of another tutorial! I hope you feel that you're starting to grasp how Superalgos works!",
+        "icon": {
+            "name": "scripts-library",
+            "project": "Superalgos"
+        },
+        "updated": 1617034361694
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Let's talk about what comes next! The page I just opened is the First Steps Tutorials book. From now on, you're free to choose what tutorials to do next!",
+            "updated": 1617034497284
+        },
+        {
+            "style": "Callout",
+            "text": "Take a look at the list of tutorials available on each of the Plugin Worspaces and choose which one to do next! I believe the order in the list may be appropriate, but it probably depends on your interests, so I'll leave it up to you!",
+            "updated": 1617034816159
+        },
+        {
+            "style": "Success",
+            "text": "See you on the next tutorial!"
+        }
+    ]
+}