Merge pull request #409 from julian-molina/develop

Contribution: Docs command errors done
This commit is contained in:
Julian Molina authored and GitHub committed 2021-01-18 21:53:54 +01:00
commit eb453f2a27
35 files changed
+191 -82

No files matched your search

@@ -0,0 +1,16 @@
{
"topic": "App Commands Messages",
"pageNumber": "1",
"type": "App Message - Contribution Done",
"definition": {
"text": "Your contributions were uploaded to your Superalgos Fork and a Pull Request was submitted to the main Superalgos repository.",
"updated": 1611002547907
},
"paragraphs": [
{
"style": "Success",
"text": "No further action from you is required. Someone will review your Pull Request and merge it into the latest version of the software should everything be in order. If your changes are rejected for any reason, you will have to follow the issue at Github.com.",
"updated": 1611002626154
}
]
}
@@ -1,7 +1,7 @@
{
"topic": "App Commands Messages",
"pageNumber": "1",
"type": "App Message - Contribution Succeed",
"type": "App Message - Contribution Done",
"definition": {
"text": "Your contributions were uploaded to your Superalgo's Fork and from there a Pull Request was submitted to the main Superalgos's repository.",
"updated": 1610478517848
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "App Message - Creating Pull Request",
"definition": {
"text": "Hold on for a minute while we upload all the changes to GitHub.com and create a pull request with your contributions in it. You will be forwarded to a results page once the operation is complete.",
"updated": 1609941046109
"text": "Hold on while changes are uploaded to GitHub.com and a Pull Request is created. You will get a new message when the operation is complete.",
"updated": 1611002766659
},
"paragraphs": [
{
@@ -14,15 +14,18 @@
},
{
"style": "Text",
"text": "Someone will review the Pull Request and if everything is alright, it will merge the changes you submitted into the develop branch of the main Superalgos repository."
"text": "No further action from you is required. Someone will review your Pull Request and merge it into the latest version of the software should everything be in order. If your changes are rejected for any reason, you will have to follow the issue at Github.com.",
"updated": 1611002796639
},
{
"style": "Text",
"text": "If you submit more contributions while the Pull Request is under review, they will be automatically added to the already open Pull Request."
"text": "If you submit more contributions while the Pull Request is under review, they will be automatically appended to the open Pull Request.",
"updated": 1611002870980
},
{
"style": "Note",
"text": "By default you will receive an email from Github.com when the changes are merged, or if the reviewer made comments on it, or reject those changes. You can manage your email suscription setting directly at GitHub.com"
"text": "You should receive an email from Github.com when changes are merged, or if the reviewer makes comments or reject the changes. You may manage your email suscription settings at GitHub.com.",
"updated": 1611002949297
}
]
}
@@ -0,0 +1,16 @@
{
"topic": "App Commands Messages",
"pageNumber": "4",
"type": "App Message - Update Done - New Version Found",
"definition": {
"text": "The update process finished successfully. A new version of Superalgos was downloaded replacing the current one. In order for the changes to take effect, you must restart the Client and refresh the UI page.",
"updated": 1611003042937
},
"paragraphs": [
{
"style": "Success",
"text": "You now have the latest version of Superalgos. Just remeber to restart the Client and the UI.",
"updated": 1610454408134
}
]
}
@@ -1,7 +1,7 @@
{
"topic": "App Commands Messages",
"pageNumber": "4",
"type": "App Message - Update Succeed - New Version Found",
"type": "App Message - Update Done - New Version Found",
"definition": {
"text": "The update process ran successfully. It found a new version of Superalgos and it download it replacing the current one. In order for the new changes to take effect, you need to restart the Client and refresh the UI page.",
"updated": 1610454363656
@@ -0,0 +1,16 @@
{
"topic": "App Commands Messages",
"pageNumber": "5",
"type": "App Message - Update Done - Already Up-To-Date",
"definition": {
"text": "The update process run successfully but no changes where made since your installation is up-to-date with the selected branch. No further action required.",
"updated": 1611003139749
},
"paragraphs": [
{
"style": "Success",
"text": "You are up-to-date. No need to reboot the Client or refresh the UI page.",
"updated": 1610454271911
}
]
}
@@ -1,7 +1,7 @@
{
"topic": "App Commands Messages",
"pageNumber": "5",
"type": "App Message - Update Succeed - Already Up-To-Date",
"type": "App Message - Update Done - Already Up-To-Date",
"definition": {
"text": "The update process was executed successfully, but no changes where found since you were running the latest version of Superalgos. No further action need to be taken.",
"updated": 1610454235682
@@ -3,8 +3,8 @@
"pageNumber": "1",
"type": "Docs Intro",
"definition": {
"text": "The Docs is a Space within Superalgos Project that allow users to search for information that explain the nodes, concepts and topics related to the different projects.",
"updated": 1609151076248
"text": "The Docs is a Space within the Superalgos Project. It allows users to search for information relative to nodes, concepts, topics, tutorials and reviews related to different projects.",
"updated": 1610999626947
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "Docs Page Category",
"definition": {
"text": "The Docs have 3 different categories of pages. Node, Concept and Topic. Each of them is a collection of pages users can read.",
"updated": 1609161546617
"text": "The Docs feature five different categories of pages. Node, Concept, Topic, Tutorial, and Review. Each of them is a collection of pages users may read.",
"updated": 1610999695838
},
"paragraphs": [
{
@@ -14,16 +14,18 @@
},
{
"style": "Text",
"text": "For each Node defined within the project, there is a Docs Node Page at the Docs, explaining what is that Node used for.",
"updated": 1609150987235
"text": "For each Node defined within the Project, there is a Docs Node Page explaining what the Node is used for.",
"updated": 1610999767253
},
{
"style": "Title",
"text": "Cocept Page Category"
"text": "Concept Page Category",
"updated": 1610999775828
},
{
"style": "Text",
"text": "Concepts are things users must know that are not needed as a Node in the system and are not ellaborate enough to become a topic."
"text": "Concepts are notions that are not represented as nodes in the system. They are not ellaborate or deep enough to require a topic.",
"updated": 1610999879515
},
{
"style": "Title",
@@ -31,7 +33,27 @@
},
{
"style": "Text",
"text": "Topics are multi-faceted concepts that needs more than one page to be correctly explained. It is a set of closely related concepts."
"text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts.",
"updated": 1610999935621
},
{
"style": "Title",
"text": "Tutorial Page Category"
},
{
"style": "Text",
"text": "Tutorials are made of steps, and each step draws information from a tutorial step page in the Docs. Pages in a tutorial are arranged in a sequence.",
"updated": 1611000079464
},
{
"style": "Title",
"text": "Reviews Page Category",
"updated": 1611000089258
},
{
"style": "Text",
"text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.",
"updated": 1611000148351
}
]
}
@@ -3,14 +3,14 @@
"pageNumber": "3",
"type": "Docs Page Name",
"definition": {
"text": "The Docs Page Name is not only the visible name of a page, but also they key to identify a page in a unique way within a Project.",
"updated": 1609151319050
"text": "The Docs Page Name is not only the visible name of a page, but also the unique identifier of a page within a Project.",
"updated": 1611000211462
},
"paragraphs": [
{
"style": "Text",
"text": "The page name can always be found at the top of each page.",
"updated": 1609151354901
"text": "The page name is always featured as the main title of the page.",
"updated": 1611000245347
}
]
}
@@ -3,8 +3,8 @@
"pageNumber": "4",
"type": "Docs Topic Name",
"definition": {
"text": "Refers to the name of the topic, which in turn is a collection of related pages at the Docs.",
"updated": 1609182060836
"text": "Refers to the name of the topic, which in turn is a collection of related pages.",
"updated": 1611000285171
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "5",
"type": "Docs Tutorial Name",
"definition": {
"text": "Refers to the name of the tutorial, which in turn is a collection of related pages at the Docs.",
"updated": 1609182060836
"text": "Refers to the name of the tutorial, which in turn is a collection of related pages.",
"updated": 1611000326995
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "6",
"type": "Docs Page Number",
"definition": {
"text": "Each topic page must have an assigned page number. The page number is used to build the topic index displayed at the top of each Docs Topic Page.",
"updated": 1609182198659
"text": "Each topic or tutorial page has a sequential page number. The page number is used to build the corresponding table of content.",
"updated": 1611000559709
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "7",
"type": "Docs Node Page",
"definition": {
"text": "Each node of each Project have a corresponding Node Page at the Docs, explaining everything to be known about that node.",
"updated": 1609182353739
"text": "Each node in a Project should have a corresponding Node Page defining the node and explaining how it is used.",
"updated": 1611000867717
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "10",
"type": "Docs Page",
"definition": {
"text": "The Docs is a collection of pages classified in 3 different categories: Docs Nodes, Docs Concepts and Docs Topics. A page contains information valuable for the users of the system.",
"updated": 1609260440891
"text": "The Docs is a collection of pages classified in five different categories: Docs Nodes, Docs Concepts, Docs Topics, Docs Tutorials, and Docs Reviews.",
"updated": 1611000990872
},
"paragraphs": [
{
@@ -3,13 +3,14 @@
"pageNumber": "12",
"type": "Docs Page Block",
"definition": {
"text": "A Page Block is a set of paragraphs within a specific Docs Page. A single Docs Page may have 0 to any number of paragraphs.",
"updated": 1609260648075
"text": "A Page Block is a set of paragraphs in a Docs Page. The block starts on the paragraph assigned the Docs Block Style.",
"updated": 1611001340654
},
"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."
"text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends until the next block starts, or until the page ends.",
"updated": 1611001401401
}
]
}
@@ -3,8 +3,8 @@
"pageNumber": "13",
"type": "Docs Nodes",
"definition": {
"text": "Docs Nodes is the set of all pages in the Docs under the Docs Page Category of Node.",
"updated": 1609260759079
"text": "Docs Nodes is the set of pages featured under the Docs Page Category Node.",
"updated": 1611001517868
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "14",
"type": "Docs Concepts",
"definition": {
"text": "Docs Concepts is the set of all pages in the Docs under the Docs Page Category of Concept.",
"updated": 1609260746120
"text": "Docs Concepts is the set of pages featured under the Docs Page Category Concept.",
"updated": 1611001547193
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "15",
"type": "Docs Topics",
"definition": {
"text": "Docs Topics is the set of all pages in the Docs under the Docs Page Category of Topic.",
"updated": 1609260810214
"text": "Docs Topics is the set of pages featured under the Docs Page Category Topic.",
"updated": 1611001570988
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "16",
"type": "Docs Books",
"definition": {
"text": "A book is page in the Docs that contains chapters. Chapters points to a Docs Topics and are rendered as the index table of the topic they point to.",
"updated": 1609771773385
"text": "A book is a page that lists chapters. A chapters points to a Docs Topics, and is rendered as the table of contents of the topic in question.",
"updated": 1611001687100
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "17",
"type": "Docs Paragraph Styles",
"definition": {
"text": "Each paragraph at a Docs Page, need to be assigend a style. The most commonly used style is the Docs Text Style.",
"updated": 1609260947769
"text": "Each paragraph in a Docs Page is assigned a style. The default and most commonly used style is the Docs Text Style.",
"updated": 1611001762378
},
"paragraphs": [
{
@@ -3,8 +3,8 @@
"pageNumber": "18",
"type": "Docs Search Engine",
"definition": {
"text": "The Docs contains a search engine that allows users to search through the collection of pages.\n",
"updated": 1609784533352
"text": "The Docs feature a search engine that allows users to search through the collection of pages.",
"updated": 1611001784831
},
"paragraphs": [
{
@@ -3,14 +3,14 @@
"pageNumber": "19",
"type": "Docs Search Engine Index",
"definition": {
"text": "The Docs Search Engine builds an in-memory index that contains all the phrases of all Docs Pages, plus the name, type, config and code of all nodes of the current Workspace.",
"updated": 1609784383995
"text": "The Docs Search Engine builds an in-memory index that contains all the phrases of all Docs Pages, plus the name, type, config, and code of all nodes of the current Workspace.",
"updated": 1611001817080
},
"paragraphs": [
{
"style": "Text",
"text": "This index is built when the UI is launched, and rebuilt when users executes the docs.reindex command or they load a new workspace.",
"updated": 1609784471513
"text": "This index is built when the UI is launched, and rebuilt when the user runs the docs.reindex command or loads a new Workspace.",
"updated": 1611001858537
}
]
}
@@ -19,8 +19,8 @@
},
{
"style": "Success",
"text": " Check the syntax of the command you are executing and see where to place the word \"to\". ",
"updated": 1609177722494
"text": "Check the syntax of the command and see where to place the word \"to\".",
"updated": 1610998959199
},
{
"style": "Title",
@@ -18,8 +18,8 @@
},
{
"style": "Success",
"text": "Check the syntax of the command you are executing and see where to place the word \"from\".",
"updated": 1609177623721
"text": "Check the syntax of the command and see where to place the word \"from\".",
"updated": 1610998988845
},
{
"style": "Title",
@@ -14,13 +14,13 @@
},
{
"style": "Error",
"text": "Changes could not be saved. There were one or more problems while saving your changes.",
"updated": 1609180259963
"text": "Changes could not be saved. There was one or more problems while saving your changes.",
"updated": 1610999017039
},
{
"style": "Success",
"text": "Please check the Client Console to see if there are errors logged there. You might also check the Browser Console for errors logged there.",
"updated": 1609180277501
"text": "Please check the Client Console to see if there are logged errors. You mayalso check the Browser Console.",
"updated": 1610999048470
},
{
"style": "Title",
@@ -3,8 +3,8 @@
"pageNumber": 12,
"type": "Docs Error - Page Already Exists",
"definition": {
"text": "The page you are trying to add already exists at Docs.",
"updated": 1609180663496
"text": "The page you are trying to add already exists.",
"updated": 1610999079334
},
"paragraphs": [
{
@@ -14,11 +14,13 @@
},
{
"style": "Error",
"text": "Page already exists at the Docs."
"text": "Page already exists.",
"updated": 1610999086141
},
{
"style": "Success",
"text": "Check the Docs Page Name you used at the command, because it seems that it already exists at the Docs."
"text": "Check the Docs Page Name you used on the command. It seems that a page with the same name already exists.",
"updated": 1610999134449
},
{
"style": "Title",
@@ -14,12 +14,13 @@
},
{
"style": "Error",
"text": "Page does not exist at the Docs. ",
"updated": 1609229439038
"text": "Page does not exist.",
"updated": 1610999156598
},
{
"style": "Success",
"text": " Check the Docs Page Name you used at the command, because it seems that a page with that name does not exist at the Docs."
"text": "Check the Docs Page Name you used on the command. It seems that a page with such name does not exist.",
"updated": 1610999206043
},
{
"style": "Title",
@@ -3,8 +3,8 @@
"pageNumber": 14,
"type": "Docs Error - Page Number Mismatch",
"definition": {
"text": "The Docs Page Number provided does not match with the Docs Page Number found at the page you want to delete. ",
"updated": 1609181698772
"text": "The Docs Page Number provided does not match with the Docs Page Number found on the page you wish to delete.",
"updated": 1610999232870
},
"paragraphs": [
{
@@ -18,8 +18,9 @@
"updated": 1609181722190
},
{
"style": "Summary",
"text": "Check the page you want to delete and get the right page number to use at the command."
"style": "Success",
"text": "Check the page you wish to delete and get the right page number to use on the command.",
"updated": 1610999262620
},
{
"style": "Title",
@@ -3,8 +3,8 @@
"pageNumber": 15,
"type": "Docs Error - Topic Mismatch",
"definition": {
"text": "The Docs Topic Name provided does not match with the Docs Topic Name found at the page you want to delete.",
"updated": 1609181659359
"text": "The Docs Topic Name provided does not match the Docs Topic Name found on the page you wish to delete.",
"updated": 1610999291997
},
"paragraphs": [
{
@@ -19,7 +19,8 @@
},
{
"style": "Success",
"text": "Check the page you want to delete and get the right Docs Topic Name to use at the command."
"text": "Check the page you wish to delete and get the correct Docs Topic Name to use on the command.",
"updated": 1610999316336
},
{
"style": "Title",
@@ -3,8 +3,8 @@
"pageNumber": 16,
"type": "Docs Error - Tutorial Mismatch",
"definition": {
"text": "The Docs Tutorial Name provided does not match with the Docs Tutorial Name found at the page you want to delete.",
"updated": 1610012937766
"text": "The Docs Tutorial Name provided does not match the Docs Tutorial Name found on the page you wish to delete.",
"updated": 1610999355066
},
"paragraphs": [
{
@@ -19,8 +19,8 @@
},
{
"style": "Success",
"text": "Check the page you want to delete and get the right Docs Tutorial Name to use at the command.",
"updated": 1610013007982
"text": "Check the page you wish to delete and get the correct Docs Tutorial Name to use on the command.",
"updated": 1610999372592
},
{
"style": "Title",
@@ -0,0 +1,30 @@
{
"topic": "Docs Commands Errors",
"pageNumber": "17",
"type": "No Matching Topic, Tutorial or Review Found",
"definition": {
"text": "The Topic or Tutorial you specified did not produce any matching pages within that Topic or Tutorial.",
"updated": 1610999403208
},
"paragraphs": [
{
"style": "Error",
"text": "No pages found. There are no Topics or Tutorials with the name provided.",
"updated": 1610398925565
},
{
"style": "Success",
"text": "Tip: Check that the name of the Topic or Tutorial provided is spelled correctly.",
"updated": 1610999441145
},
{
"style": "Title",
"text": "Applies to"
},
{
"style": "List",
"text": "Docs Repaginate Command",
"updated": 1610398971728
}
]
}
@@ -13,7 +13,7 @@
"paragraphs": [
{
"style": "Text",
"text": "If everything went well with your authentication, you should be seeing the Contribution Succeeded message!",
"text": "If everything went well with your authentication, you should be seeing the Contribution Done message!",
"updated": 1610913443275
},
{
@@ -80,7 +80,7 @@ function newSuperalgosDocsCommmandInterface() {
/* Lets check the result of the call through the http interface */
data = JSON.parse(data)
if (err.result === GLOBAL.DEFAULT_OK_RESPONSE.result && data.result === GLOBAL.DEFAULT_OK_RESPONSE.result) {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Contribution Succeed')
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Contribution Done')
} else {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error - Contribution Not Sent', 'Anchor Contribution Not Sent')
}
@@ -131,9 +131,9 @@ function newSuperalgosDocsCommmandInterface() {
data = JSON.parse(data)
if (err.result === GLOBAL.DEFAULT_OK_RESPONSE.result && data.result === GLOBAL.CUSTOM_OK_RESPONSE.result) {
if (data.message.summary.changes + data.message.summary.deletions + data.message.summary.insertions > 0) {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Update Succeed - New Version Found')
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Update Done - New Version Found')
} else {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Update Succeed - Already Up-To-Date')
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Message - Update Done - Already Up-To-Date')
}
} else {
UI.projects.superalgos.spaces.docsSpace.navigateTo('Superalgos', 'Topic', 'App Error - Update Failed', 'Anchor Update Failed')
+2 -2
View File
@@ -30,7 +30,7 @@ Git is an open-source distributed version control system required to download an
**b.** Download the version for your Operating System.
**c.** Run the installer and go through the process until Git is fully installed.
**c.** Run the installer with the default configuration — just click Next until Git is fully installed.
## Google Chrome
@@ -44,7 +44,7 @@ Before you begin, it is recommended that you set up Chrome as your default brows
**Important:** Use Chrome so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently.
# Superalgos App Installation
# Superalgos Client Installation
**1.** If you are not there already, go to [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)