diff --git a/Projects/Superalgos/Icons/Thumbs.db b/Projects/Superalgos/Icons/Thumbs.db index f1195350f..81066df30 100644 Binary files a/Projects/Superalgos/Icons/Thumbs.db and b/Projects/Superalgos/Icons/Thumbs.db differ diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.32-tutorial-step-before-you-switch.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.32-tutorial-step-before-you-switch.json new file mode 100644 index 000000000..ac7ce32b5 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.32-tutorial-step-before-you-switch.json @@ -0,0 +1,35 @@ +{ + "tutorial": "Contribute to Superalgos!", + "pageNumber": "7.32", + "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!", + "icon": { + "name": "bullet-warning", + "project": "Superalgos" + }, + "updated": 1617018123415 + }, + "paragraphs": [ + { + "style": "List", + "text": "It may happen that the workspaces or other data structures in the master branch are not compatible with those in the develop branch. ", + "updated": 1617017830521 + }, + { + "style": "List", + "text": "If the current workspace is incompatible with the software in the other branch, the workspace may break upon reloading the app. In such a case, you must load a Plugin Workspace of the new branch.", + "updated": 1617018153708 + }, + { + "style": "List", + "text": "Even the structure of mined data may have changed!", + "updated": 1617017781902 + }, + { + "style": "Important", + "text": "Always check the README file in the develop branch of the repository for any comments on backward compatibility. Before switching branches, it is always good to back up your work!", + "updated": 1617017837289 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.34-tutorial-step-double-trouble.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.34-tutorial-step-double-trouble.json new file mode 100644 index 000000000..b6f7fc161 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.34-tutorial-step-double-trouble.json @@ -0,0 +1,30 @@ +{ + "tutorial": "Contribute to Superalgos!", + "pageNumber": "7.34", + "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!", + "updated": 1617018855666, + "icon": { + "name": "clone-entity", + "project": "Superalgos" + } + }, + "paragraphs": [ + { + "style": "Text", + "text": "You may have two clones of your fork running from separate folders, one of them in the develop branch.", + "updated": 1617018731051 + }, + { + "style": "Note", + "text": "Two instances of Superalogs running from different folders are completely independent. They run distinct workspaces and output unique data.", + "updated": 1617018971209 + }, + { + "style": "Success", + "text": "Such a setup allows you to run the stable version for your production tasks, and the version in develop to contribute and test new features!", + "updated": 1617018806324 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.36-tutorial-step-lets-switch-already.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.36-tutorial-step-lets-switch-already.json new file mode 100644 index 000000000..82b73c198 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-.36-tutorial-step-lets-switch-already.json @@ -0,0 +1,43 @@ +{ + "tutorial": "Contribute to Superalgos!", + "pageNumber": "7.36", + "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!", + "icon": { + "name": "docs-success-style", + "project": "Superalgos" + }, + "updated": 1617019411568 + }, + "paragraphs": [ + { + "style": "Text", + "text": "This is what you need to do:", + "updated": 1617019437652 + }, + { + "style": "List", + "text": "Go back to the footer and select Develop as your Current Branch.", + "updated": 1617019546125 + }, + { + "style": "List", + "text": "You will get a page explaining what is being done. Once the process finishes, you will get another page telling you of the outcome.", + "updated": 1617019740630 + }, + { + "style": "List", + "text": "Stop / close the app (browser and console).", + "updated": 1617019826262 + }, + { + "style": "List", + "text": "Restart the app!" + }, + { + "style": "List", + "text": "Find the Contribute to Superalgos Tutorial in the bottom-right corner of the workspace and select Resume in the menu!" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-012-tutorial-step-get-ready-to-push.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-012-tutorial-step-get-ready-to-push.json index 141aa3030..1397cf384 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-012-tutorial-step-get-ready-to-push.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-012-tutorial-step-get-ready-to-push.json @@ -18,23 +18,23 @@ }, { "style": "List", - "text": "git.add: adds the changes you've made to contributable files to a git commit.", - "updated": 1610743268237 + "text": "git add: adds the changes you've made to contributable files to a git commit.", + "updated": 1616948426317 }, { "style": "List", - "text": "git.commit: commits all the changes.", - "updated": 1610743294792 + "text": "git commit: commits all the changes.", + "updated": 1616948431365 }, { "style": "List", - "text": "git.push: pushes the changes to your fork.", - "updated": 1610743337006 + "text": "git push: pushes the changes to your fork.", + "updated": 1616948435342 }, { "style": "List", - "text": "github.createPullRequest: creates a Pull Request at the Superalgos repository, or add commits to an existing Pull Request.", - "updated": 1610743396382 + "text": "github createPullRequest: creates a Pull Request at the Superalgos repository, or add commits to an existing Pull Request.", + "updated": 1616948441848 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-016-tutorial-step-set-up-the-token.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-016-tutorial-step-set-up-the-token.json index 1855df3c2..1d6b268f2 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-016-tutorial-step-set-up-the-token.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-016-tutorial-step-set-up-the-token.json @@ -11,11 +11,6 @@ "updated": 1610815737032 }, "paragraphs": [ - { - "style": "Note", - "text": "Github API is currently at the \"Getting Started\" workspace, under APIs.", - "updated": 1615593559409 - }, { "style": "Callout", "text": "Copy the token, open the Github API node config, and paste it between the double quotes of the token parameter. Fill in the username parameter with your GitHub.com user, not your email!" diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-018-tutorial-step-contributable-files.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-018-tutorial-step-contributable-files.json index 624714ef8..07762fb1e 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-018-tutorial-step-contributable-files.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-018-tutorial-step-contributable-files.json @@ -18,8 +18,8 @@ }, { "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": 1610884811294 + "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 folders) 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": 1616948683272 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-020-tutorial-step-congrats-and-thank-you.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-020-tutorial-step-congrats-and-thank-you.json index c3a0cd6a5..aaca4a4c6 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-020-tutorial-step-congrats-and-thank-you.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-020-tutorial-step-congrats-and-thank-you.json @@ -13,8 +13,8 @@ "paragraphs": [ { "style": "Text", - "text": "If everything went well with your authentication, you should see the Contribution Done message!", - "updated": 1611595956742 + "text": "If everything went well with your authentication, you should see the App Message - Contribution Done page!", + "updated": 1617023256176 }, { "style": "Callout", diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.2-tutorial-step-switching-branches.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.2-tutorial-step-switching-branches.json index 986f2a084..2cdc0d634 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.2-tutorial-step-switching-branches.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.2-tutorial-step-switching-branches.json @@ -13,8 +13,8 @@ "paragraphs": [ { "style": "Text", - "text": "Superalgos is constantly improving. At some point, you may wish to try the software version in the develop branch. Maybe there is a new feature, or a fix for bug that hasn't got to the master branch yet...", - "updated": 1616760221737 + "text": "Superalgos is constantly improving. At some point, you may wish to try the software version in the develop branch. Maybe there is a new feature, or a fix for a bug that hasn't got to the master branch yet...", + "updated": 1617007301530 }, { "style": "Success", diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.3-tutorial-step-now-the-current-branch.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.3-tutorial-step-now-the-current-branch.json index bd279af24..4aaa034f8 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.3-tutorial-step-now-the-current-branch.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.3-tutorial-step-now-the-current-branch.json @@ -13,13 +13,13 @@ "paragraphs": [ { "style": "Text", - "text": "Now it's time to change the current branch. When you do that, the app will run a series of Git commands that will download the software from the develop branch of your fork! The current software will be replaced on your disk! For that reason, you will need to close the app after switching, restart, find the tutorial and resume!", - "updated": 1616873624278 + "text": "Now it's time to change the Current Branch! When you do that, the app will run a series of Git commands that will download the software from the develop branch of your fork! The current software will be automatically replaced on your disk! For that reason, you will need to close the app after switching, restart, find the tutorial and resume to keep going!", + "updated": 1617017990927 }, { - "style": "Callout", - "text": "Go back to the footer and select Develop as your Current Branch. Follow the instructions to close the app when the process is done. When you restart, find the tutorial in the bottom-right corner of the workspace and select Resume in the menu!", - "updated": 1616873590554 + "style": "Important", + "text": "But before you switch branches, let's take a moment to think of the consequences!", + "updated": 1617008246622 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.4-tutorial-step-welcome-back.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.4-tutorial-step-welcome-back.json new file mode 100644 index 000000000..9fbb6f0a2 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.4-tutorial-step-welcome-back.json @@ -0,0 +1,25 @@ +{ + "tutorial": "Contribute to Superalgos!", + "pageNumber": "7.4", + "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!", + "icon": { + "name": "hits", + "project": "Superalgos" + }, + "updated": 1617007379836 + }, + "paragraphs": [ + { + "style": "Text", + "text": "The software you are currently running is the version of Superalgos that was at the develop branch the day you forked the project! This is because the process of switching branches downloads the software from your fork and not the upstream repository.", + "updated": 1617020053004 + }, + { + "style": "Success", + "text": "You need to update so that you run the latest version! This is particularly important when you intend to contribute to the project. You should always work on the latest version so that the changes you make include the latest changes produced by other contributors!", + "updated": 1617020167891 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.5-tutorial-step-update-the-app.json b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.5-tutorial-step-update-the-app.json new file mode 100644 index 000000000..4c01bd13f --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.5-tutorial-step-update-the-app.json @@ -0,0 +1,33 @@ +{ + "tutorial": "Contribute to Superalgos!", + "pageNumber": "7.5", + "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!", + "icon": { + "name": "indicator-process-instance", + "project": "Superalgos" + }, + "updated": 1617020636889 + }, + "paragraphs": [ + { + "style": "Text", + "text": "That means that you may use this command on either of the branches! This is it:", + "updated": 1617020758219 + }, + { + "style": "Json", + "text": "app.update" + }, + { + "style": "Callout", + "text": "Copy and run the command!" + }, + { + "style": "Success", + "text": "Once the update is done, you will need to close the app again, restart it, find the tutorial and click Resume, just like you did earlier!", + "updated": 1617020620260 + } + ] +} \ No newline at end of file