diff --git a/Projects/Superalgos/Icons/Thumbs.db b/Projects/Superalgos/Icons/Thumbs.db index a1689950e..a6cdc7d5b 100644 Binary files a/Projects/Superalgos/Icons/Thumbs.db and b/Projects/Superalgos/Icons/Thumbs.db differ diff --git a/Projects/Superalgos/Schemas/Docs-Topics/app-commands-001-app-contribute-command.json b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-001-app-contribute-command.json index bce411506..c8b92efe2 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/app-commands-001-app-contribute-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/app-commands-001-app-contribute-command.json @@ -3,8 +3,8 @@ "pageNumber": "1", "type": "App Contribute Command", "definition": { - "text": "This command allows you to contribute the changes you have made to the Docs, code, plugins, etc. to the Superalgos main repository so that all other users can enjoy those contributions once they update their installation.", - "updated": 1609943282530 + "text": "This command allows you to contribute work to the project. The contribution goes to the Superalgos repository via a Pull Request from your Superalgos fork.", + "updated": 1610909304702 }, "paragraphs": [ { @@ -23,8 +23,8 @@ }, { "style": "List", - "text": "Message: It is a text that briefly describes what your contribution is about. It is optional.", - "updated": 1609943656035 + "text": "Message: Enter a brief description of what your contribution is about. It is optional but appreciated.", + "updated": 1610909386562 }, { "style": "Title", @@ -43,27 +43,25 @@ }, { "style": "Text", - "text": "When you run this command the system will do this:" + "text": "This is what the command does:", + "updated": 1610909409653 }, { "style": "List", - "text": "git.add: It will add all the changes to a git commit.", - "updated": 1609944157893 + "text": "git.add: adds the changes you've made to contributable files to a git commit.", + "updated": 1610909452789 }, { "style": "List", - "text": "git.commit: It will git commit all the changes.", - "updated": 1609944167291 + "text": "git.commit: commits all the changes." }, { "style": "List", - "text": "git.push: It will push the changes to your Superalgos fork.", - "updated": 1609944179406 + "text": "git.push: pushes the changes to your fork." }, { "style": "List", - "text": "github.createPullRequest: It will create a Pull Request at the Superalgos/Superalgos repository, or it will add the commit to an already open Pull Request.", - "updated": 1609944217509 + "text": "github.createPullRequest: creates a Pull Request at the Superalgos repository, or add commits to an existing Pull Request." }, { "style": "Block", @@ -76,17 +74,18 @@ }, { "style": "Text", - "text": "In order for the App Contribute Command to run, two things need to happen:", - "updated": 1609945880855 + "text": "For the App Contribute Command to run properly, two different authentications are required:", + "updated": 1610909501561 }, { "style": "List", - "text": "Git Authentication: The first time you run this command, Git will open a pop up window that will ask you for your Github.com credentials. This happens only once. Git will use these credential to be able to push the commit to your own Superalgos fork at Github.com." + "text": "Git Authentication: The first time you run this command, Git will open a pop up window that will ask you for your Github.com credentials. This happens only once. Git will use these credentials to push the commit to your Superalgos fork at Github.com.", + "updated": 1610909551187 }, { "style": "List", - "text": "Github Authentication: The creation of the Pull Request is something that happens at Github.com and for this operation you need to authenticate yourself. They way to do it, is to generate a token and set it up at the Github Api node's config in your workspace.", - "updated": 1609944902844 + "text": "Github.com Authentication: The creation of the Pull Request is something that happens at Github.com and for this operation you need to authenticate too. To do this, you must generate a Personal Access Token and set it up at the Github Api node configuration in your active workspace.", + "updated": 1610909615254 }, { "style": "Subtitle", @@ -94,7 +93,8 @@ }, { "style": "List", - "text": "You can create the token by following this link:" + "text": "Create the token by following this link:", + "updated": 1610909635250 }, { "style": "Link", @@ -107,7 +107,8 @@ }, { "style": "Text", - "text": "Once you have your token, find in the workspace the GitHub API node (you can search for it here at the Docs). The config of this node is something like this:" + "text": "Once you have your token, find the GitHub API node (you may search for it in the Documentation). The configuration looks like this:", + "updated": 1610909728136 }, { "style": "Javascript", @@ -116,21 +117,8 @@ }, { "style": "Text", - "text": "If you can't find the node it is because it is not there. We only include it at the Getting Started Workspace. Don't worry you can create it. Just do this:", - "updated": 1609946259572 - }, - { - "style": "List", - "text": "Superalgos Project: Find this node." - }, - { - "style": "List", - "text": "Other Hierarchies: You can use this to create the APIs node.", - "updated": 1609946284646 - }, - { - "style": "List", - "text": "APIs: Use it to creat Github API" + "text": "If you can't find the node by using the search box, it may not exist in the active workspace. The APIs hierarchy is included by default in the Getting Started workspace only. You may spawn a new APIs hierarchy from the Other Hierarchies node in the Superalgos Project hierarchy.", + "updated": 1610909893231 }, { "style": "Subtitle", @@ -138,15 +126,61 @@ }, { "style": "List", - "text": "username: type here your GitHub.com username." + "text": "username: Type your GitHub.com username.", + "updated": 1610909927500 }, { "style": "List", - "text": "token: Paste here the token you have just created." + "text": "token: Paste the token you created.", + "updated": 1610909948426 }, { "style": "Note", - "text": "Now you are all set. You might run the command at any time after you made some changes, either by editing / adding to the Docs, translating content, adding a Plugin, fixing a bug at the code, etc." + "text": "You may run the command any time after you made and saved changes.", + "updated": 1610910009790 + }, + { + "style": "Title", + "text": "Troubleshooting Authentication Issues", + "updated": 1610909171028 + }, + { + "style": "Text", + "text": "Some issues may arrise when you have more than one Git installation active in your OS.", + "updated": 1610910061699 + }, + { + "style": "Text", + "text": "For example, if you see the following authentication screen, it means an older version of Git is trying to deal with the authentication:" + }, + { + "style": "Png", + "text": "PNGs/Superalgos/Docs/third-parties/git-github-authentication.png", + "updated": 1610910471806 + }, + { + "style": "Text", + "text": "The current authentication screen is similar to this one instead:", + "updated": 1610910533633 + }, + { + "style": "Png", + "text": "PNGs/Superalgos/Docs/third-parties/sign-in-with-your-browser.png", + "updated": 1610910579507 + }, + { + "style": "Important", + "text": "If you didn't install the latest version of Git before installing Superalgos, then that is likely the reason the authentication is not working. The latest version of Git is required.", + "updated": 1610910817057 + }, + { + "style": "Success", + "text": "If you did install Git and you are experiencing the issue described above, restarting your PC may help things sort themselves out.", + "updated": 1610910739376 + }, + { + "style": "Text", + "text": "" }, { "style": "Text", diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-124-tutorial-step-set-up-the-token.json b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-124-tutorial-step-set-up-the-token.json index 3a9e528f6..f675192a9 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-124-tutorial-step-set-up-the-token.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-124-tutorial-step-set-up-the-token.json @@ -13,8 +13,8 @@ "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 + "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": 1610910956757 }, { "style": "Note", diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-127-tutorial-step-lets-run-the-command.json b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-127-tutorial-step-lets-run-the-command.json new file mode 100644 index 000000000..7892de0d1 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-127-tutorial-step-lets-run-the-command.json @@ -0,0 +1,30 @@ +{ + "tutorial": "Welcome to Superalgos!", + "pageNumber": "127", + "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!", + "updated": 1610912478164, + "icon": { + "name": "docs-json-code-style", + "project": "Superalgos" + } + }, + "paragraphs": [ + { + "style": "Javascript", + "text": "app.contribute My Superalgos review", + "updated": 1610911943908 + }, + { + "style": "Success", + "text": "A GitHub sing in dialog should pop-up offering you to authenticate with your token or password. Just follow the process with either!", + "updated": 1610912816654 + }, + { + "style": "Important", + "text": "The latest version of Git is required for this to work! If you have issues authenticating with the latest version, restarting the PC may help.", + "updated": 1610913072372 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-129-tutorial-step-congrats-and-thank-you.json b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-129-tutorial-step-congrats-and-thank-you.json new file mode 100644 index 000000000..058fbba5e --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/welcome-to-superalgos-129-tutorial-step-congrats-and-thank-you.json @@ -0,0 +1,15 @@ +{ + "tutorial": "Welcome to Superalgos!", + "pageNumber": "129", + "type": "Tutorial Step - Congrats and Thank You!", + "definition": { + "text": "We are grateful for your first contribution!", + "updated": 1610913277985 + }, + "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