Merge pull request #573 from julian-molina/develop

Contribution: How to Contribute to the Docs

Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json

@@ -149,10 +149,56 @@
             "style": "Block",
             "text": "Contributions Reminder"
         },
+        {
+            "style": "Title",
+            "text": "Switch to the Develop Branch and Update Before You Start",
+            "updated": 1613811592905
+        },
         {
             "style": "Note",
-            "text": "All contributions must be submitted to the Develop branch. Make sure you update to the latest version in Develop and that everything you are submitting works properly in that version.",
-            "updated": 1613588289291
+            "text": "All contributions must be submitted to the Develop branch. Make sure you update to the latest version in Develop and that everything you are submitting works properly in that version."
+        },
+        {
+            "style": "Subtitle",
+            "text": "Switch to Develop",
+            "updated": 1613811609773
+        },
+        {
+            "style": "Text",
+            "text": "To switch to the develop branch:"
+        },
+        {
+            "style": "List",
+            "text": "Go to the footer of this page."
+        },
+        {
+            "style": "List",
+            "text": "Select Develop under the Contributions Branch title. "
+        },
+        {
+            "style": "List",
+            "text": "Then select Develop under the Choose the Current Branch title. "
+        },
+        {
+            "style": "List",
+            "text": "Follow the instructions to close and restart the app.",
+            "updated": 1613810110150
+        },
+        {
+            "style": "Subtitle",
+            "text": "Update to the Latest Version"
+        },
+        {
+            "style": "List",
+            "text": "Run the App Update Command"
+        },
+        {
+            "style": "Json",
+            "text": "app.update"
+        },
+        {
+            "style": "List",
+            "text": "Close the app and restart."
         },
         {
             "style": "Block",

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-002-icons-design-brief.json

@@ -1,42 +0,0 @@
-{
-    "topic": "Contributing to Superalgos",
-    "pageNumber": "2",
-    "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!",
-        "updated": 1613378806864
-    },
-    "paragraphs": [
-        {
-            "style": "Title",
-            "text": "Attribution",
-            "updated": 1613378838786
-        },
-        {
-            "style": "Text",
-            "text": "The original set of icons is a web design pack made by Freepik and is available at:",
-            "updated": 1613378893975
-        },
-        {
-            "style": "Link",
-            "text": "flaticon.com https://www.flaticon.com/packs/web-design-10?k=1596385749125",
-            "updated": 1613378913044
-        },
-        {
-            "style": "Text",
-            "text": "The rest of the series is inspired in the design style developed for the original set."
-        },
-        {
-            "style": "Text",
-            "text": "The authorship of each icon not in the original series is indicated by the contributor’s identity in the Graphics repository."
-        },
-        {
-            "style": "Text",
-            "text": "asdf"
-        },
-        {
-            "style": "Text",
-            "text": "asdf"
-        }
-    ]
-}

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-003-how-to-contribute-to-the-docs.json

@@ -0,0 +1,93 @@
+{
+    "topic": "Contributing to Superalgos",
+    "pageNumber": "3",
+    "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.",
+        "updated": 1613810324131
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Coordination",
+            "updated": 1613819062207
+        },
+        {
+            "style": "Text",
+            "text": "Join the Docs Group to coordinate efforts with other contributors:",
+            "updated": 1613819084738
+        },
+        {
+            "style": "Link",
+            "text": "Docs Group->https://t.me/superalgosdocs"
+        },
+        {
+            "style": "Text",
+            "text": "Please, introduce yourself and get up to speed with the group currently doing the work. The main coordination efforts involve planning the documentation of new functionality or discussing which sections of the Docs need a revision.",
+            "updated": 1613819203043
+        },
+        {
+            "style": "Include",
+            "text": "Superalgos->Concept->Reusable Snippets->Contributions Reminder"
+        },
+        {
+            "style": "Title",
+            "text": "Learn How the Docs Work",
+            "updated": 1613811876102
+        },
+        {
+            "style": "Text",
+            "text": "You probably have an idea of how the Docs work from using the app and doing the first few tutorials. If you intend to contribute the occasional small fixes on existing pages, you probably know enough to start contributing!",
+            "updated": 1613819282818
+        },
+        {
+            "style": "Text",
+            "text": "However, if you wish to get involved in documenting new functionality, reorganizing topics, arranging books, and so on, you should read The Docs Explained book.",
+            "updated": 1613819297682
+        },
+        {
+            "style": "Title",
+            "text": "Logistics and Best Practice",
+            "updated": 1613817330818
+        },
+        {
+            "style": "Text",
+            "text": "There may be several people contributing to the Docs at any point in time. To minimize the occurrence of conflicts at the time of merging your contributions into the Superalgos repository, the following practices are highly recommended.",
+            "updated": 1613819314231
+        },
+        {
+            "style": "List",
+            "text": "Update your app frequently so that you incorporate recent changes other users may have submitted.",
+            "updated": 1613817514502
+        },
+        {
+            "style": "List",
+            "text": "Do not keep changes locally for too long. Split your work and submit your contributions every day.",
+            "updated": 1613817561886
+        },
+        {
+            "style": "Text",
+            "text": "When you run the App Contribute Command, a Pull Request is created at your fork. The Superalgos repo maintainers will look into your submission and determine if it may be merged as is, or if the work requires any adjustments.",
+            "updated": 1613818674004
+        },
+        {
+            "style": "List",
+            "text": "Keep track of your contributions until they are merged.",
+            "updated": 1613818739120
+        },
+        {
+            "style": "List",
+            "text": "Stay responsive if there is any feedback or requests from maintainers.",
+            "updated": 1613818758881
+        },
+        {
+            "style": "List",
+            "text": "Be attentive to emails you may get from GitHub.com",
+            "updated": 1613819348463
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}