fez5587/Superalgos
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #731 from julian-molina/develop

Browse Source 
Contribution: Contribute tutorial update
This commit is contained in:
Julian Molina authored and GitHub committed 2021-03-27 22:33:49 +01:00
2 parents cd95e9d112 72d3ee37c3
commit 2cbc1b3bfe
11 files changed
+175 -56
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Projects/Superalgos/Icons/Thumbs.db
BIN
View File
Binary file not shown.
Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json
+28 -15
View File
@@ -3,13 +3,14 @@
"pageNumber": 3,
"type": "Docs Page Category",
"definition": {
"text": "The Docs feature six categories of pages: nodes, concepts, topics, tutorials, reviews, and books. Each category is represented by a tab in the Docs Search Results.",
"updated": 1613759267463,
"text": "The Docs feature six categories of pages: Node, Concept, Topic, Tutorial, Review, and Book. Each category is represented by a tab in the Docs Search Results.",
"updated": 1616876130108,
"translations": [
{
"language": "ID",
"text": "Didalam dokumen ini menampilkan enam kategori halaman yaitu: nodes, concepts, topics, tutorials, reviews, dan books. Setiap kategori diwakilkan oleh sebuah tab dalam Docs Search Results.",
"updated": 1613859527741
"updated": 1613859527741,
"style": "Definition"
}
]
},
@@ -26,7 +27,8 @@
{
"language": "ID",
"text": "Kategori Halaman Node ",
"updated": 1613859587112
"updated": 1613859587112,
"style": "Title"
}
]
},
@@ -37,7 +39,8 @@
{
"language": "ID",
"text": "Setiap Node ditentukan dalam konteks Project yang menampilkan Docs Node Page yang menjelaskan apa itu Node dan bagaimana penggunaannya. Halaman ini akan terbuka saat mengklik tombol bantuan di menu node.",
"updated": 1613859807031
"updated": 1613859807031,
"style": "Text"
}
]
},
@@ -48,7 +51,8 @@
{
"language": "ID",
"text": "Kategori Halaman Concept",
"updated": 1613859855103
"updated": 1613859855103,
"style": "Title"
}
]
},
@@ -59,7 +63,8 @@
{
"language": "ID",
"text": "Konseps adalah pemikiran atau gagasan yang tidak direpresentasikan sebagai node dalam hierarcy. Halaman dalam kategori konsep mencakup pemikiran atau gagasan yang dapat dijelaskan dalam satu halaman. Intinya, konsep adalah gagasan yang dapat dibahas secara lengkap dalam satu halaman.",
"updated": 1613860012881
"updated": 1613860012881,
"style": "Text"
}
]
},
@@ -70,7 +75,8 @@
{
"language": "ID",
"text": "Kategori Halaman Topic",
"updated": 1613860037593
"updated": 1613860037593,
"style": "Title"
}
]
},
@@ -81,7 +87,8 @@
{
"language": "ID",
"text": "Topik adalah konsep yang lebih dalam dan memiliki banyak segi yang membutuhkan lebih dari satu halaman untuk dijelaskan. Topik adalah sekumpulan konsep yang berkaitan erat, disusun secara berurutan. Namun, bukan halaman itu saja. Melainkan, ini adalah kumpulan dari halaman-halaman.",
"updated": 1613860164710
"updated": 1613860164710,
"style": "Text"
}
]
},
@@ -92,7 +99,8 @@
{
"language": "ID",
"text": "Kategori Halaman Tutorial",
"updated": 1613860197070
"updated": 1613860197070,
"style": "Title"
}
]
},
@@ -103,7 +111,8 @@
{
"language": "ID",
"text": "Adapun dalam Tutorial adalah hirarki yang dapat mengatur berbagai jenis node termasuk node Tutorial Topic dan Tutorial Step. Setiap node dalam hierarki mengarah ke Tutorial Step di Docs tempat sumber informasi. Dalam konteks Docs, halaman dalam tutorial diatur secara runtut seperti topik.",
"updated": 1613860411843
"updated": 1613860411843,
"style": "Text"
}
]
},
@@ -114,7 +123,8 @@
{
"language": "ID",
"text": "Kategori Halaman Reviews",
"updated": 1613860442084
"updated": 1613860442084,
"style": "Title"
}
]
},
@@ -125,7 +135,8 @@
{
"language": "ID",
"text": "Reviews adalah konten buatan pengguna yang menjelaskan pengalaman mereka dengan komponen tertentu dari Superalgos atau proyek lain.",
"updated": 1613860497517
"updated": 1613860497517,
"style": "Text"
}
]
},
@@ -136,7 +147,8 @@
{
"language": "ID",
"text": "Kategori Halaman Books",
"updated": 1613860532720
"updated": 1613860532720,
"style": "Title"
}
]
},
@@ -147,7 +159,8 @@
{
"language": "ID",
"text": "Books merupakan halaman itu sendiri. Halaman tersebut menampilkan daftar topik yang masing-masing merupakan satu bab dalam buku tersebut.",
"updated": 1613860614179
"updated": 1613860614179,
"style": "Text"
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-002-tutorial-wanna-help-come-on-in.json
+9 -4
View File
@@ -13,13 +13,18 @@
"paragraphs": [
{
"style": "Text",
"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
"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!",
"updated": 1616871630234
},
{
"style": "Note",
"text": "The skills you will learn will also allow you to start contributing to the project! Remember, this is a community project... We are all expected to give back and keep improving the software!",
"updated": 1616871682807
},
{
"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! Contributing, by the way, earns you Superalgos (SA) tokens!",
"updated": 1616756731723
"text": "By the way, contributing to the project earns you Superalgos (SA) tokens!",
"updated": 1616871695678
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-004-tutorial-step-free-for-everyone.json
+2 -2
View File
@@ -23,8 +23,8 @@
},
{
"style": "Text",
"text": "The friends soon realized that to compete with top market players a huge software infrastructure was required. The system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team in a reasonable timeframe.",
"updated": 1611594362033
"text": "The friends soon realized that to compete with top market players a huge software infrastructure was required. The system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team —at least not in a reasonable timeframe.",
"updated": 1616871844068
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-006-tutorial-step-what-is-a-contribution.json
+2 -2
View File
@@ -18,8 +18,8 @@
},
{
"style": "List",
"text": "Fixing a typo, a dead link, and improving the docs.",
"updated": 1610716935723
"text": "Fixing a typo, a dead link, and improving the Docs.",
"updated": 1616871916250
},
{
"style": "List",
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-007-tutorial-step-what-about-free-riders.json
+8 -8
View File
@@ -3,8 +3,8 @@
"pageNumber": 7,
"type": "Tutorial Step - What About Free Riders?",
"definition": {
"text": "Free riders are a problem, but we choose to assume goodwill! We trust that once you start helping the project, other people will be inspired and follow!",
"updated": 1611594822992,
"text": "Free-ridding is not cool! We know that once you start contributing, you will inspire more people to follow your lead!",
"updated": 1616872224110,
"icon": {
"name": "bullet-error",
"project": "Superalgos"
@@ -13,8 +13,8 @@
"paragraphs": [
{
"style": "Text",
"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
"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": 1616872270381
},
{
"style": "Link",
@@ -22,13 +22,13 @@
},
{
"style": "Success",
"text": "This means that our first choice to deal with free-riding is the positive route!",
"updated": 1610983728515
"text": "We combat free-ridding with incentives!",
"updated": 1616872334799
},
{
"style": "Callout",
"text": "Let's get your first contribution rolling!",
"updated": 1616758026205
"text": "Let's get your first contribution rolling! First, I'll teach you how to switch branches!",
"updated": 1616872424219
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-008-tutorial-step-lets-add-your-review.json
+4 -3
View File
@@ -18,7 +18,8 @@
},
{
"style": "Javascript",
"text": "docs.add Review to Superalgos: Superalgos Project Review->Superalgos Review - YOUR REVIEW TITLE"
"text": "docs.add Review to Superalgos: Superalgos Project Review->Superalgos Review - Your Review Title",
"updated": 1616878234259
},
{
"style": "List",
@@ -32,8 +33,8 @@
},
{
"style": "List",
"text": "THIRD: Replace YOUR REVIEW TITLE with a meaningful title. Review titles must be unique!",
"updated": 1610822662803
"text": "THIRD: Replace \"Your Review Title\" with a meaningful title. Review titles must be unique!",
"updated": 1616878262273
},
{
"style": "List",
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-009-tutorial-step-did-it-work.json
+7 -22
View File
@@ -3,38 +3,23 @@
"pageNumber": 9,
"type": "Tutorial Step - Did It Work?",
"definition": {
"text": "If you didn't mess up the command, you should be seeing a new page with the title you set, an invitation to write a summary, and more below!",
"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!",
"icon": {
"name": "docs-action-edit-paragraph",
"project": "Superalgos"
},
"updated": 1610731827383
"updated": 1616875304376
},
"paragraphs": [
{
"style": "Note",
"text": "If you are getting an error message, read it and fix the problem! It's likely about the syntax in the command. Remember you may always go back a step to recover the original command!",
"updated": 1610732596680
"text": "If you got an error message, read it and fix the problem! It's likely about the syntax in the command. You may always go back a step to recover the original command!",
"updated": 1616875472251
},
{
"style": "List",
"text": "Right-click and select the pencil icon to edit.",
"updated": 1610732029994
},
{
"style": "List",
"text": "To exit edit mode, hit the Escape key.",
"updated": 1610822743193
},
{
"style": "List",
"text": "To add new paragraphs, edit the last one, click Enter and keep writing. See what happens when you exit!",
"updated": 1610732334559
},
{
"style": "List",
"text": "To change styles, right-click and explore the menu!",
"updated": 1610732414111
"style": "Success",
"text": "In the next step, we'll analyze how the command works!",
"updated": 1616875421406
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-7.3-tutorial-step-now-the-current-branch.json
+25
View File
@@ -0,0 +1,25 @@
{
"tutorial": "Contribute to Superalgos!",
"pageNumber": "7.3",
"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!",
"icon": {
"name": "github",
"project": "Superalgos"
},
"updated": 1616873181582
},
"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
},
{
"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
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-9.2-tutorial-step-breaking-up-the-command.json
+50
View File
@@ -0,0 +1,50 @@
{
"tutorial": "Contribute to Superalgos!",
"pageNumber": "9.2",
"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!",
"icon": {
"name": "copy-path",
"project": "Superalgos"
},
"updated": 1616875920510
},
"paragraphs": [
{
"style": "List",
"text": "docs.add: the root syntax of the Docs Add Command",
"updated": 1616876987593
},
{
"style": "List",
"text": "Review: the Docs Page Category of the page",
"updated": 1616876171594
},
{
"style": "List",
"text": "to: a coloquial connector to improve readability",
"updated": 1616876202410
},
{
"style": "List",
"text": "Superalgos: the Project to which the page is added",
"updated": 1616876249121
},
{
"style": "List",
"text": "Superalgos Project Review: the name of the collection of pages the review belongs to",
"updated": 1616877226375
},
{
"style": "List",
"text": "->: a separator used in commands that require two user-defined parameters (in this case, the name of the collection of pages, and the name of the page)",
"updated": 1616876585726
},
{
"style": "List",
"text": "Superalgos Review - Your Review Title: this is the Docs Page Name; we repeat Superalgos Review in the page name to lower the odds of duplicate names",
"updated": 1616878613905
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/contribute-to-superalgos-9.4-tutorial-step-editing-crash-course.json
+40
View File
@@ -0,0 +1,40 @@
{
"tutorial": "Contribute to Superalgos!",
"pageNumber": "9.4",
"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...",
"icon": {
"name": "docs-action-edit-paragraph",
"project": "Superalgos"
},
"updated": 1616880288897
},
"paragraphs": [
{
"style": "Title",
"text": "This is an H1... H2 is smaller!",
"updated": 1616880079733
},
{
"style": "List",
"text": "Ab|: creates bullet lists like this one!",
"updated": 1616880058110
},
{
"style": "Note",
"text": "The fourth column features notes (like this one), along with tips, important, and warning boxes.",
"updated": 1616880610556
},
{
"style": "Javascript",
"text": "Use JS to add code === \"styled by prism!\"",
"updated": 1616880323719
},
{
"style": "Text",
"text": "Abc| turns the paragraph back to plain text. That should be enough to make your review look great! I'll explain the rest of the menu at a later time!",
"updated": 1616880538943
}
]
}