From efcf92c964c2fb4750dfb3767e1d8535e91efe3f Mon Sep 17 00:00:00 2001 From: Luis Fernando Molina Date: Tue, 9 Feb 2021 14:36:45 +0100 Subject: [PATCH] Update troubleshooting-001-how-to-troubleshoot-an-issue.json --- ...ting-001-how-to-troubleshoot-an-issue.json | 94 ++++++++++++------- 1 file changed, 62 insertions(+), 32 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/troubleshooting-001-how-to-troubleshoot-an-issue.json b/Projects/Superalgos/Schemas/Docs-Topics/troubleshooting-001-how-to-troubleshoot-an-issue.json index cbe30863a..31050debf 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/troubleshooting-001-how-to-troubleshoot-an-issue.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/troubleshooting-001-how-to-troubleshoot-an-issue.json @@ -3,8 +3,8 @@ "pageNumber": "1", "type": "How to Troubleshoot an Issue", "definition": { - "text": "Following these logical steps will help you better understand the system and find solutions to most of the issues you may run into.", - "updated": 1611509381460 + "text": "This Troubleshooting Guide teaches you the logical steps that will help you better understand the system and find solutions to most of the issues you may run into.", + "updated": 1612874252158 }, "paragraphs": [ { @@ -22,8 +22,13 @@ }, { "style": "Important", - "text": "Thoroughly following this troubleshooting guide—step by step—is a requirement for reporting an issue. We can not afford to investigate issues that you may solve on your own, or without the appropriate information. Doing so would rob the project of valuable resources.", - "updated": 1611509548445 + "text": "Thoroughly following this troubleshooting guide—step by step—is a requirement for reporting an issue or asking for help in the Support Group. We can not afford to investigate issues that you may solve on your own, or without the appropriate information. Doing so would rob the project of valuable resources.", + "updated": 1612875019106 + }, + { + "style": "Success", + "text": "Before you even start troubleshooting, you should do all the tutorials available. This is the single best piece of advice you may get, as tutorials will teach you all the basic operations and will clarify most of the questions that derive from a lack of understanding of how the system works. Please, go to the First Steps Tutorials book and do some learning! Please do not ask for help before you do all tutorials!", + "updated": 1612874358930 }, { "style": "Title", @@ -35,33 +40,47 @@ }, { "style": "List", - "text": "If you are following the Download and Set Up guide or the Welcome tutorial, read caferully and make sure you haven’t skipped any steps." + "text": "If you are following the Welcome tutorial, read carefully and make sure you haven’t skipped any steps. Go back a few steps and try again.", + "updated": 1612876297808 }, { "style": "List", - "text": "If you are already using the system, take some time to search the documentation and read the pages related to the matters you are working with. Use the search box on the top-right corner to search for the specific matter (i.e. backtesting, data mining, etc.)", - "updated": 1611509580552 + "text": "If you are already using the system, take some time to search the Docs and read the topics related to the matters you are working with. Use the search box to search for the specific matter (backtesting, data mining, etc.)", + "updated": 1612875081868 }, { "style": "List", - "text": "If you are having trouble with a specific node on the design space, open the menu and click the button. A new tab will open in your browser with the description of the corresponding node in the corresponding hierarchy directory. Read about the node, it’s parent node, and its offspring." + "text": "If you are having trouble with a specific node on the Design Space, open the menu and click the help button. The Docs will open with a description of what the node is and how it works. Read about the node, its parent node, and its offspring.", + "updated": 1612876337693 }, { "style": "List", - "text": "If you are having trouble operating the charts, make sure you revisit the Welcome tutorial and the interface section of the Charting Space." + "text": "If you are having trouble operating the charts, make sure you revisit the Welcome tutorial and the pages on Time Machines and Timeline Charts, and Scales.", + "updated": 1612874724546 + }, + { + "style": "List", + "text": "If you are not sure what you should search for, go to the User Manual book and scan the topics covered there. If you are serious about learning Superalgos, reading the whole User Manual will put you at the top of the food chain.", + "updated": 1612874813098 }, { "style": "Success", - "text": "There is no substitute for knowledge. The more you understand, the less time and effort you will waste with issues related to a lack of understanding, and the more focused your questions will be when asking for help. You may be inclined to take a shortcut and ask the community before doing your research. This may save you some time occasionally and may be appropriate in cases in which you need a little guidance or need to clear a quick doubt, particularly if you are a beginner and are still following the Getting Started Guide. However, the problem with lack of understanding is that it is a persistent condition until you deal with the root cause. The way to deal with the root cause is taking the time to read the documentation. Otherwise, you will find yourself dealing with the same constraints over and over again. Acquiring knowledge while being mindful of the Team’s time is the first step towards becoming a valuable member of the community.", - "updated": 1611509589990 + "text": "There is no substitute for knowledge. The more you understand, the less time and effort you will waste with issues related to a lack of understanding, and the more focused your questions will be when asking for help. You may be inclined to take a shortcut and ask the community before doing your research. This may save you some time occasionally and may be appropriate in cases in which you need a little guidance or need to clear a quick doubt. However, the problem with lack of understanding is that it is a persistent condition until you deal with the root cause. The way to deal with the root cause is to take the time to do all the First Steps Tutorials and read the User Manual. Otherwise, you will find yourself dealing with the same constraints over and over again. Acquiring knowledge while being mindful of the Team’s time is the first step towards becoming a valuable member of the community.", + "updated": 1612876358894 }, { "style": "Subtitle", - "text": "2. Scan the troubleshooting section" + "text": "2. Scan the Troubleshooting topic", + "updated": 1612875503760 + }, + { + "style": "Subtitle", + "text": "" }, { "style": "Text", - "text": "Chances are someone else has experienced a similar issue as you may be experiencing now. We do our best to compile common issues into specific troubleshooting pages, so make sure you take a look there before moving on." + "text": "Chances are someone else has experienced a similar issue as you may be experiencing now. We do our best to compile common issues into specific troubleshooting pages, so make sure you take a look there before moving on. This page is the first on the Troubleshooting topic. Find the rest in the TOC at the bottom of this page.", + "updated": 1612876381614 }, { "style": "Subtitle", @@ -69,11 +88,13 @@ }, { "style": "Text", - "text": "Open your operating system’s Task Manager application and verify the CPU load while you reproduce the issue you are experiencing. If your CPU is running at 100% for more than 30 to 60 seconds, all sorts of problems may arise, as your hardware is not able to cope with the system requirements." + "text": "Open your operating system’s task manager application and verify the CPU load while you reproduce the issue you are experiencing. If your CPU is running at 100% for more than 30 to 60 seconds, all sorts of problems may arise, as your hardware may not able to cope with what you may be trying to do.", + "updated": 1612875430945 }, { "style": "Text", - "text": "If this is the case, try closing any other applications that may be demanding CPU time, and follow the guidelines proposed in the My System Gets Slow page to lower the demands on the processor." + "text": "If this is the case, try closing other applications that may be demanding CPU time, and follow the guidelines proposed in the Perception Issues - My System Gets Slow page to lower the demands on the processor.", + "updated": 1612875476873 }, { "style": "Text", @@ -89,16 +110,18 @@ }, { "style": "Note", - "text": "Making sure means installing the latest version, right now.", - "updated": 1611509626109 + "text": "Making sure means installing the latest version, right now. You may run the App Update Command.", + "updated": 1612875559806 }, { "style": "Subtitle", - "text": "5. Does the issue persist when using one of the official workspaces?" + "text": "5. Does the issue persist when using one of the plugin workspaces?", + "updated": 1612875632190 }, { "style": "Text", - "text": "If the issue may not be reproduced using one of the official workspaces, that likely means that modifications you may have introduced may be playing a role in the issue. In and of itself, this is a crucial piece of information that helps start the process of isolating the issue." + "text": "If the issue may not be reproduced using one of the plugin workspaces, that likely means that modifications you may have introduced may be playing a role in the issue. In and of itself, this is a crucial piece of information that helps start the process of isolating the issue.", + "updated": 1612875627341 }, { "style": "Text", @@ -106,7 +129,8 @@ }, { "style": "Text", - "text": "Start over and reproduce the modifications on the official workspace, one at a time, and make a quick test after each mod is applied. This process done right should lead you to the exact node, structure of nodes, configuration, parameter, or—in general—the modification that may be involved in the cause of the issue." + "text": "Start over and reproduce the modifications on the plugin workspace, one at a time, and make a quick test after each mod is applied. This process done right should lead you to the exact node, structure of nodes, configuration, parameter, or—in general—the modification that may be involved in the cause of the issue.", + "updated": 1612875667631 }, { "style": "Note", @@ -152,15 +176,18 @@ }, { "style": "Text", - "text": "If your machine shut down unexpectedly or you closed the backend servers running in the console application without first stopping your data mining tasks, chances are some of your data may have been corrupted. If you suspect this may have something to do with your issue, then you should check the integrity of your data." + "text": "If your machine shut down unexpectedly or you closed the backend servers running in the console application without first stopping your data mining tasks, chances are some of your data may have been corrupted. If you suspect this may have something to do with your issue, then you should read Investigating Issues - Check the Integrity of Your Data.", + "updated": 1612875847548 }, { "style": "Subtitle", - "text": "8. May this be an issue with the frontend application?" + "text": "8. May this be an issue with the GUI?", + "updated": 1612875863222 }, { "style": "Text", - "text": "If your issue happens within the frontend application, then you should either be getting an on-screen error or an error on your browser console application." + "text": "If your issue happens within the GUI, then you should either be getting an on-screen error or an error on your browser console application.", + "updated": 1612875875780 }, { "style": "Text", @@ -173,25 +200,28 @@ }, { "style": "Important", - "text": "Remember that Chrome is the only supported browser. If you are using any other browser and have frontend issues, we may not be able to reproduce the issue. Do not report an issue with the frontend unless you are using Chrome.", - "updated": 1611509692825 + "text": "Remember that Chrome and Safari on Mac are the only supported browsers. If you are using any other browsers and have GUI issues, we may not be able to reproduce them. Do not report an issue with the GUI unless you are using Chrome or Safari.", + "updated": 1612876423477 }, { "style": "Subtitle", - "text": "9. May this be an issue with the backend application?" + "text": "9. May this be an issue with the Client application?", + "updated": 1612875983271 }, { "style": "Text", - "text": "If there are issues with the backend application, then errors must be logged at the console where you are running the backend. The same errors are logged in the Log-Files folder and the specific sub-folders corresponding to the processes involved in the matter." + "text": "If there are issues with the Client application, then errors must be logged at the console where you are running the backend. The same errors are logged in the Log-Files folder and the specific sub-folders corresponding to the processes involved in the matter.", + "updated": 1612875992279 }, { - "style": "Text", - "text": " Note: Make sure you check the logs for the specific processes involved in the matter, and save the corresponding log files with these errors so that you may report them later." + "style": "Note", + "text": "Make sure you check the logs for the specific processes involved in the mater, and save the corresponding log files with these errors so that you may report them later.", + "updated": 1612876447343 }, { "style": "Success", - "text": "If you are a developer, remember that you may easily debug a task to find the root cause of the issue.", - "updated": 1611509706433 + "text": "If you are a developer, remember that you may easily debug a task to find the root cause of the issue. Read Debugging a Task.", + "updated": 1612876057032 }, { "style": "Subtitle", @@ -206,7 +236,7 @@ "text": "If you have issues with a particular setup, feel free to ask for help from other users in the community, but do not open an issue for the Team to look into." }, { - "style": "Text", + "style": "Title", "text": "Has Your Issue Not Been Resolved?" }, {