Merge pull request #727 from julian-molina/develop

Contribution: Footer and translation pages

Client/WebServer/css/docs.css

@@ -520,14 +520,14 @@ color: #ffd1a9;
 
 .docs-footer-language {
 width: 30px;
-margin-top: 10px;
-padding: 10 10px;
+margin-top: 7px;
+padding: 7 7px;
 }
 
 .docs-footer-language-selected {
     width: 30px;
-    margin-top: 10px;
-    padding: 10 10px;
+    margin-top: 7px;
+    padding: 7 7px;
     background-color: rgba(230, 234, 234, 0.2);
 /* border: 1px solid rgba(205, 212, 213, 0.5); DELETE Candidate*/
 border: 1px solid rgba(200, 200, 200, .5);

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-004-how-to-contribute-translations.json

@@ -23,9 +23,9 @@
             "updated": 1613822457097
         },
         {
-            "style": "Note",
-            "text": "Before you being, please read the page Docs In English.",
-            "updated": 1613822688747
+            "style": "Include",
+            "text": "Superalgos->Topic->Docs In English->Content",
+            "updated": 1616762047762
         },
         {
             "style": "Text",
@@ -48,9 +48,14 @@
             "updated": 1613824072677
         },
         {
-            "style": "Text",
-            "text": "As explained in the How to Contribute to the Docs page, you must switch to the develop branch and make sure your system is up to date.",
-            "updated": 1613825583367
+            "style": "List",
+            "text": "As explained in the How to Contribute to the Docs page, you must switch your Contributions Branch and your Current Branch to the develop branch. Remember to restart the app after the switch.",
+            "updated": 1616762259778
+        },
+        {
+            "style": "List",
+            "text": "Make sure your system is up to date running the app.update command.",
+            "updated": 1616762308286
         },
         {
             "style": "List",
@@ -71,6 +76,11 @@
             "text": "Remember that translations exist at the level of each paragraph. Always make sure that the translation you input matches the correct paragraph. This is important because if a paragraph is updated in the English version, all translations will get a notice that the particular paragraph may be outdated.",
             "updated": 1613824142107
         },
+        {
+            "style": "List",
+            "text": "Participate in the Superalgos Docs Group. Let people know what part of the Docs or which Tutorial you will be working with. This basic coordination will help avoid conflicts when more than one user works on the same pages at the same time.",
+            "updated": 1616762526615
+        },
         {
             "style": "Success",
             "text": "You may start with the translation of the Docs in [Language] page that you land on after you switch the language.",

Projects/Superalgos/Schemas/Docs-Topics/docs-languages-001-docs-in-english.json

@@ -7,19 +7,19 @@
         "updated": 1613820592771
     },
     "paragraphs": [
+        {
+            "style": "Block",
+            "text": "Content",
+            "updated": 1616761358289
+        },
         {
             "style": "Text",
-            "text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
-            "updated": 1613820612132
+            "text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead."
         },
         {
             "style": "Text",
             "text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
         },
-        {
-            "style": "Success",
-            "text": "If you wish to contribute translations, read the How to Contribute Translations page."
-        },
         {
             "style": "Success",
             "text": "To switch languages, click on the flags on the footer of the Docs."
@@ -28,6 +28,15 @@
             "style": "Note",
             "text": "You may only add or delete pages to the Docs when the language is set to English.",
             "updated": 1613820648230
+        },
+        {
+            "style": "Block",
+            "text": "End"
+        },
+        {
+            "style": "Success",
+            "text": "If you wish to contribute translations, read the How to Contribute Translations page.",
+            "updated": 1616761556162
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-002-tutorial-wanna-help-come-on-in.json

@@ -3,8 +3,8 @@
     "pageNumber": 2,
     "type": "Tutorial - Wanna Help? Come On In!",
     "definition": {
-        "text": "Welcome to the Community! If you're still around, with the first two tutorials under your belt, you're family already!",
-        "updated": 1616756140158,
+        "text": "You're still around, now with the first two tutorials under your belt! You're family already! Welcome to the Community!",
+        "updated": 1616757706219,
         "icon": {
             "name": "tutorial",
             "project": "Superalgos"
@@ -13,13 +13,13 @@
     "paragraphs": [
         {
             "style": "Text",
-            "text": "In this tutorial, you are going to learn to keep your system up to date, use the built-in command line, switch branches, and a few more tricks that will make your life easier and —at the same time— help you become a valuable member of the community!",
-            "updated": 1616756564380
+            "text": "In this tutorial, you will learn to keep your system up to date, use the built-in command line, switch branches, and a few more tricks that will make your life easier and —at the same time— help you become a valuable member of the community!",
+            "updated": 1616757725384
         },
         {
             "style": "Success",
-            "text": "The skills you will learn will also allow you to start contributing to the project! Remember, this is a community project and we are all expected to give back, help drive the project forwards, and keep improving the software!",
-            "updated": 1616756575794
+            "text": "The skills you will learn will also allow you to start contributing to the project! Remember, this is a community project and we are all expected to give back, help drive the project forwards, and keep improving the software! Contributing, by the way, earns you Superalgos (SA) tokens!",
+            "updated": 1616756731723
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-003-tutorial-step-you-are-in-command.json

@@ -3,8 +3,8 @@
     "pageNumber": 3,
     "type": "Tutorial Step - You Are In Command",
     "definition": {
-        "text": "The search box in the Docs has a double life. Sometimes she searches, but other times she commands, and does stuff... whatever you tell her!",
-        "updated": 1611595553272,
+        "text": "Let's talk about my friend, the search box in the Docs. She has a bit of a double life: she searches, but also commands!",
+        "updated": 1616756994691,
         "icon": {
             "name": "strategy-manage-stage",
             "project": "Superalgos"
@@ -13,13 +13,13 @@
     "paragraphs": [
         {
             "style": "Text",
-            "text": "I mean the search box is also a command line interface! The list of available commands has to do with:",
-            "updated": 1611595675031
+            "text": "I mean the search box is also a command line interface! The current list of commands has to do with:",
+            "updated": 1616757022931
         },
         {
             "style": "List",
-            "text": "Producing and editing the Documentation.",
-            "updated": 1610719727338
+            "text": "Producing and editing the Docs.",
+            "updated": 1616757048012
         },
         {
             "style": "List",

Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-007-tutorial-step-what-about-free-riders.json

@@ -13,8 +13,12 @@
     "paragraphs": [
         {
             "style": "Text",
-            "text": "The project will soon implement an incentives scheme to further promote the desired behavior and to foster the culture of collaboration.",
-            "updated": 1610720058284
+            "text": "The project has implemented a powerful incentives scheme to promote the desired behavior and to foster a culture of collaboration: we are distributing the Superalgos (SA) token exclusively among contributors!",
+            "updated": 1616757601802
+        },
+        {
+            "style": "Link",
+            "text": "Learn more about the Superalgos (SA) Token!->superalgos.org/token-overview.shtml"
         },
         {
             "style": "Success",
@@ -23,8 +27,8 @@
         },
         {
             "style": "Callout",
-            "text": "Enough preamble! Let's get on with it!",
-            "updated": 1611594786356
+            "text": "Let's get your first contribution rolling!",
+            "updated": 1616758026205
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.2-tutorial-step-switching-branches.json

@@ -0,0 +1,30 @@
+{
+    "tutorial": "Contribute to Superalgos!",
+    "pageNumber": "7.2",
+    "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!",
+        "updated": 1616759979604,
+        "icon": {
+            "name": "github",
+            "project": "Superalgos"
+        }
+    },
+    "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
+        },
+        {
+            "style": "Success",
+            "text": "Or you may wish to submit a contribution, which must always be sent to the develop branch!",
+            "updated": 1616760455582
+        },
+        {
+            "style": "Callout",
+            "text": "Scroll down the Docs page to the footer and select Develop as your Contributions Branch! It's the option on the right-hand side, not in the center!",
+            "updated": 1616760852432
+        }
+    ]
+}

Projects/Superalgos/UI/Spaces/Docs-Space/Footer.js

@@ -67,7 +67,7 @@ function newSuperalgosDocsFooter() {
 
         HTML = HTML + '<div class="docs-footer-cell">'
         HTML = HTML + '<h4>Choose Your Language</h4>'
-        HTML = HTML + 'Click to change your preferred language:<br/>'
+        HTML = HTML + 'Click on your preferred language:<br/>'
 
         HTML = HTML + '<a href="#" onClick="UI.projects.superalgos.spaces.docsSpace.changeLanguage(\'EN\')"><img src="Images/Languages/EN.png" title="English" class="docs-footer-language'
         if (languageCode === 'EN') { 
@@ -108,12 +108,8 @@ function newSuperalgosDocsFooter() {
         HTML = HTML + '</div>'
 
         HTML = HTML + '<div class="docs-footer-cell">'
-        HTML = HTML + '<h4>To Contribute Translations</h4>'
-        HTML = HTML + '<strong>1. </strong>Switch to your language.<br/>'
-        HTML = HTML + '<strong>2. </strong>Edit and translate English content.<br/>'
-        HTML = HTML + '<strong>3. </strong>Save changes typing <code class="docs-footer-code">docs.save</code>.<br/>'
-        HTML = HTML + '<strong>4. </strong>Type <code class="docs-footer-code">app.contribute</code> to update your fork and submit a PR.<br/>'
-        HTML = HTML + '</ol>'
+        HTML = HTML + '<h4>Contribute Translations</h4>'
+        HTML = HTML + 'Earn tokens by helping translate the Docs and tutorials to your native language! Search the Docs for How to Contribute Translations and join the Superalgos Docs Group to coordinate with other contributors...'
         HTML = HTML + '</div>'
 
         HTML = HTML + '</div>'
@@ -136,7 +132,7 @@ function newSuperalgosDocsFooter() {
         HTML = HTML + '<div class="docs-footer-row">'
         HTML = HTML + '<div class="docs-footer-cell">'
         HTML = HTML + '<h4>About Your Deployment</h4>'
-        HTML = HTML + 'Superalgos may run from different branches in the repository. The <code class="docs-footer-code">Master</code> branch features the stable version, and the <code class="docs-footer-code">Develop</code> branch the version in development open for testing.'
+        HTML = HTML + 'Superalgos may run from different branches in the repository. The <code class="docs-footer-code">Master</code> branch features the stable version, and the <code class="docs-footer-code">Develop</code> branch the version in development.'
         HTML = HTML + '</div>'
 
         HTML = HTML + '<div class="docs-footer-cell">'
@@ -181,7 +177,9 @@ function newSuperalgosDocsFooter() {
         HTML = HTML + '<li><a href="https://t.me/superalgossupport" target="_blank">Technical Support Group</a></li>'
         HTML = HTML + '<li><a href="https://t.me/superalgosdevelop" target="_blank">Developers Group</a></li>'
         HTML = HTML + '<li><a href="https://t.me/superalgosmachinelearning" target="_blank">Machine Learning Group</a></li>'
+        HTML = HTML + '<li><a href="https://t.me/superalgosdocs" target="_blank">Docs Group</a></li>'
         HTML = HTML + '<li><a href="https://t.me/superalgosuxui" target="_blank">UX/UI Design Group</a></li>'
+        HTML = HTML + '<li><a href="https://t.me/superalgoscollaborations" target="_blank">Collaborations Group</a></li>'
         HTML = HTML + '</ul>'
         HTML = HTML + '</div>'