Merge pull request #582 from retiutut/updatedWebLinksNewDocs

Update links to OpenBCI Forum and new Docs at GitHub Pages

Author: retiutut

CHANGELOG.md

@@ -1,6 +1,11 @@
 # v4.1.5
 Use OpenBCIHub v2.0.9 please.
 
+## Beta 3
+
+### Bug fixes
+* Update links to OpenBCI Forum and new Docs at GitHub Pages
+
 ## Beta 2
 
 ### Bug fixes

OpenBCI_GUI/ControlPanel.pde

@@ -1178,7 +1178,7 @@ class ControlPanel {
                         popOutWifiConfigButton.setString("<");
                     } else {
                         if (wifi_portName == "N/A") {
-                            output("Please select a WiFi Shield first. Can't see your WiFi Shield? Learn how at docs.openbci.com/Tutorials/03-Wifi_Getting_Started_Guide");
+                            output("Please select a WiFi Shield first. Can't see your WiFi Shield? Learn how at openbci.github.io/Documentation/");
                         } else {
                             output("Attempting to connect to WiFi Shield named " + wifi_portName);
                             hub.examineWifi(wifi_portName);
@@ -1654,7 +1654,7 @@ public void initButtonPressed(){
         }
     } else {
         //if system is already active ... stop session and flip button state back
-        outputInfo("Learn how to use this application and more at docs.openbci.com");
+        outputInfo("Learn how to use this application and more at openbci.github.io/Documentation/");
         initSystemButton.setString("START SESSION");
         cp5.get(Textfield.class, "fileNameCyton").setText(getDateString()); //creates new data file name so that you don't accidentally overwrite the old one
         cp5.get(Textfield.class, "fileNameGanglion").setText(getDateString()); //creates new data file name so that you don't accidentally overwrite the old one
@@ -1691,7 +1691,7 @@ class NoHubBox {
         padding = _padding;
 
         noHubShowDoc = new Button (x + padding, y + padding*2 + 13, w - padding*2, 24, "OPENBCI GUI INSTALL GUIDE", fontInfo.buttonLabel_size);
-        noHubShowDoc.setURL("http://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI");
+        noHubShowDoc.setURL("https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs");
     }
 
     public void draw() {

OpenBCI_GUI/Debugging.pde

@@ -54,7 +54,7 @@ class HelpWidget {
     int padding;
 
     //current text shown in help widget, based on most recent command
-    String currentOutput = "Learn how to use this application and more at docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI";
+    String currentOutput = "Learn how to use this application and more at openbci.github.io/Documentation/";
     OutputLevel curOutputLevel = OutputLevel.INFO;
 
     HelpWidget(float _xPos, float _yPos, float _width, float _height) {

OpenBCI_GUI/Info.plist.tmpl

@@ -23,7 +23,7 @@
         <key>CFBundleShortVersionString</key>
         <string>4</string>
         <key>CFBundleVersion</key>
-        <string>4.1.5-beta.2</string>
+        <string>4.1.5-beta.3</string>
         <key>CFBundleSignature</key>
         <string>????</string>
         <key>NSHumanReadableCopyright</key>

OpenBCI_GUI/InterfaceHub.pde

@@ -459,7 +459,7 @@ class Hub {
                 break;
             case RESP_ERROR_WIFI_NEEDS_UPDATE:
                 println("Error in processConnect: RESP_ERROR_WIFI_NEEDS_UPDATE");
-                killAndShowMsg("WiFi Shield Firmware is out of date. Learn to update: docs.openbci.com/Hardware/12-Wifi_Programming_Tutorial");
+                killAndShowMsg("WiFi Shield Firmware is out of date. Learn to update: https://openbci.github.io/Documentation/docs/05ThirdParty/03-WiFiShield/WiFiProgam");
                 break;
             default:
                 println("Error in processConnect");
@@ -485,7 +485,7 @@ class Hub {
                 output("WiFi Shield is still connected to " + wifi_portName);
                 break;
             case RESP_ERROR_UNABLE_TO_CONNECT:
-                output("No WiFi Shield found, visit docs.openbci.com/Tutorials/03-Wifi_Getting_Started_Guide to learn how to connect.");
+                output("No WiFi Shield found. Please visit https://openbci.github.io/Documentation/docs/01GettingStarted/01-Boards/WiFiGS");
                 break;
             default:
                 if (wcBox.isShowing) println("it is showing"); //controlPanel.hideWifiPopoutBox();
@@ -799,7 +799,7 @@ class Hub {
                 }
                 break;
             case RESP_ERROR_PROTOCOL_BLE_START:
-                outputError("Failed to start Ganglion BLE Driver, please see http://docs.openbci.com/Tutorials/02-Ganglion_Getting%20Started_Guide");
+                outputError("Failed to start Ganglion BLE Driver, please see https://openbci.github.io/Documentation/docs/01GettingStarted/01-Boards/GanglionGS");
                 break;
             default:
                 message = json.getString(TCP_JSON_KEY_MESSAGE);

OpenBCI_GUI/OpenBCI_GUI.pde

@@ -56,7 +56,7 @@ import com.sun.jna.Pointer;
 //                       Global Variables & Instances
 //------------------------------------------------------------------------
 //Used to check GUI version in TopNav.pde and displayed on the splash screen on startup
-String localGUIVersionString = "v4.1.5-beta.2";
+String localGUIVersionString = "v4.1.5-beta.3";
 String localGUIVersionDate = "August 2019";
 String guiLatestReleaseLocation = "https://github.com/OpenBCI/OpenBCI_GUI/releases/latest";
 Boolean guiVersionCheckHasOccured = false;
@@ -345,7 +345,7 @@ void setup() {
     println("Console Log Started at Local Time: " + getDateString());
     println("Screen Resolution: " + displayWidth + " X " + displayHeight);
     println("Welcome to the Processing-based OpenBCI GUI!"); //Welcome line.
-    println("For more information, please visit: https://docs.openbci.com/OpenBCI%20Software/");
+    println("For more information, please visit: https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs");
 
     //open window
     ourApplet = this;

OpenBCI_GUI/TopNav.pde

@@ -1141,28 +1141,28 @@ class TutorialSelector {
         int buttonNumber = 0;
         Button tempTutorialButton = new Button(x + margin, y + margin*(buttonNumber+1) + b_h*(buttonNumber), b_w, b_h, "Getting Started");
         tempTutorialButton.setFont(p5, 12);
-        tempTutorialButton.setURL("https://docs.openbci.com/Tutorials/01-Cyton_Getting%20Started_Guide");
+        tempTutorialButton.setURL("https://openbci.github.io/Documentation/docs/01GettingStarted/GettingStartedLanding");
         tutorialOptions.add(tempTutorialButton);
 
         buttonNumber = 1;
         h = margin*(buttonNumber+2) + b_h*(buttonNumber+1);
         tempTutorialButton = new Button(x + margin, y + margin*(buttonNumber+1) + b_h*(buttonNumber), b_w, b_h, "Testing Impedance");
         tempTutorialButton.setFont(p5, 12);
-        tempTutorialButton.setURL("https://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI#the-openbci-gui-impedance-testing");
+        tempTutorialButton.setURL("https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs#impedance-testing");
         tutorialOptions.add(tempTutorialButton);
 
         buttonNumber = 2;
         h = margin*(buttonNumber+2) + b_h*(buttonNumber+1);
         tempTutorialButton = new Button(x + margin, y + margin*(buttonNumber+1) + b_h*(buttonNumber), b_w, b_h, "OpenBCI Forum");
         tempTutorialButton.setFont(p5, 12);
-        tempTutorialButton.setURL("https://openbci.com/index.php/forum/");
+        tempTutorialButton.setURL("https://openbci.com/forum/");
         tutorialOptions.add(tempTutorialButton);
 
         buttonNumber = 3;
         h = margin*(buttonNumber+2) + b_h*(buttonNumber+1);
         tempTutorialButton = new Button(x + margin, y + margin*(buttonNumber+1) + b_h*(buttonNumber), b_w, b_h, "Building Custom Widgets");
         tempTutorialButton.setFont(p5, 12);
-        tempTutorialButton.setURL("https://docs.openbci.com/Tutorials/16-Custom_Widgets");
+        tempTutorialButton.setURL("https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIWidgets#custom-widget");
         tutorialOptions.add(tempTutorialButton);
     }
 }

OpenBCI_GUI/W_Template.pde

@@ -28,7 +28,7 @@ class W_template extends Widget {
 
         widgetTemplateButton = new Button (x + w/2, y + h/2, 200, navHeight, "Design Your Own Widget!", 12);
         widgetTemplateButton.setFont(p4, 14);
-        widgetTemplateButton.setURL("https://docs.openbci.com/Tutorials/16-Custom_Widgets");
+        widgetTemplateButton.setURL("https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIWidgets#custom-widget");
     }
 
     void update(){

README.md

@@ -111,7 +111,7 @@ OpenGL acceleration is required.
 
 
 ## Troubleshooting
-The OpenBCI Hub comes installed in recent versions of the GUI. When running the GUI from Processing code, please follow these instructions for getting the **critical** piece of software called the OpenBCI HUB [Mac/Linux](http://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI#the-openbci-gui-running-the-openbci-gui-from-the-processing-ide-install-openbci-hub-on-maclinux) [Windows](http://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI#the-openbci-gui-install-openbci-hub-on-windows). Thanks and happy hacking!
+The OpenBCI Hub comes installed in recent versions of the GUI. When running the GUI from Processing code, [please follow these instructions](https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs#install-openbci-hub-on-mac-linux-windows) for getting the **critical** piece of software called the OpenBCI HUB for Mac/Linux/Windows. Thanks and happy hacking!
 
 ## <a name="license"></a> License:
 
@@ -123,5 +123,5 @@ MIT
 [link_shop_cyton_daisy]: https://shop.openbci.com/collections/frontpage/products/cyton-daisy-biosensing-boards-16-channel
 [link_ptw]: https://www.pushtheworldllc.com
 [link_openbci]: http://www.openbci.com
-[link_gui_widget_tutorial]: http://docs.openbci.com/Tutorials/15-Custom_Widgets
-[link_gui_run_from_processing]: http://docs.openbci.com/OpenBCI%20Software/01-OpenBCI_GUI#the-openbci-gui-running-the-openbci-gui-from-the-processing-ide
+[link_gui_widget_tutorial]: https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIWidgets#custom-widget
+[link_gui_run_from_processing]: https://openbci.github.io/Documentation/docs/06Software/01-OpenBCISoftware/GUIDocs#running-the-openbci-gui-from-the-processing-ide