gui

Author: Tom-Willemsen

.gitignore

@@ -2,3 +2,4 @@
 .venv/
 ibex_developers_manual.egg-info/
 build/
+_build/

doc/Gui.md

@@ -0,0 +1,44 @@
+# IBEX GUI (Eclipse)
+
+## Getting Started
+
+```{toctree}
+:glob:
+:titlesonly:
+
+client/Building-the-GUI
+client/GUI-Development-Workflow
+client/Maven-and-Tycho
+```
+
+## Coding
+
+```{toctree}
+:glob:
+:titlesonly:
+
+client/GUI-Coding-Conventions
+client/An-Introduction-to-Databinding
+client/Adding-a-Plugin-or-Feature-to-Maven-Build
+client/Connecting-a-View-to-a-PV
+client/Static-analysis
+client/Instrument-switching
+client/PV-Switching
+client/OPI-Creation
+client/Adding-a-Button-to-the-Perspective-Switcher
+```
+
+## Testing
+
+```{toctree}
+:glob:
+:titlesonly:
+
+client/An-Introduction-to-Unit-Testing
+client/Adding-Unit-Tests
+client/Using-Mockito-for-Testing-in-the-GUI
+client/System-Testing-with-Squish
+client/Test-naming
+```
+
+# Web Dashboard

doc/Processes.md

@@ -9,6 +9,7 @@ processes/Tickets-and-their-Workflow
 processes/Umbrella-Tickets
 processes/Dependency-Updates
 processes/External-Contributions
+processes/Component-and-Activity-Stewards
 ```
 
 # Meetings
@@ -25,6 +26,7 @@ processes/Sprint-Planning
 processes/Sprint-Review-and-Retro
 processes/Program-Increment-Planning
 processes/Technical-Debt-Stand-down
+processes/Code-Chats-and-Lightning-Talks
 ```
 
 ## External meetings

doc/uncategorised/GUI_development/Testing/Adding-Unit-Tests.md renamed to doc/client/Adding-Unit-Tests.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Testing](GUI-Testing) > Adding tests
+# Adding tests
 
 For more detailed information see [an_introduction_to_unit_testing.rst](https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/An-Introduction-to-Unit-Testing).
 

doc/uncategorised/GUI_development/Coding/Adding-a-Button-to-the-Perspective-Switcher.md renamed to doc/client/Adding-a-Button-to-the-Perspective-Switcher.md

@@ -1,4 +1,5 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Coding](GUI-Coding) > Adding a perspective
+# Adding a perspective
+
 ![Perspective Switcher](GUI_development/images/adding_a_button_to_the_perspective_switcher/IBEX_complete_perspective_switcher_highlighted.png)
 
 

doc/uncategorised/GUI_development/Coding/Adding-a-Plugin-or-Feature-to-Maven-Build.md renamed to doc/client/Adding-a-Plugin-or-Feature-to-Maven-Build.md

@@ -1,8 +1,8 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Coding](GUI-Coding) > Adding a plugin or feature to Maven
+# Adding a plugin or feature to Maven
 
 The steps for adding a plug-in (one small part of IBEX, such as the blocks view) or feature (a larger collection of plug-ins, such as CSS) to the maven build are below:
 
-# Step by step:
+## Step by step:
 * Add the plug-in to `feature.base`:
     * Open `feature.xml` in `uk.ac.stfc.isis.ibex.feature.base`
     * Go to "Included Plug-ins" (or "Included Features") tab and click "Add..."

doc/uncategorised/GUI_development/Coding/An-Introduction-to-Databinding.md renamed to doc/client/An-Introduction-to-Databinding.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Coding](GUI-Coding) > Data binding
+# Data binding
 
 Note: there are some helpful tips to common errors/mistakes [here](Databinding---common-mistakes).
 

doc/uncategorised/GUI_development/Testing/An-Introduction-to-Unit-Testing.md renamed to doc/client/An-Introduction-to-Unit-Testing.md

@@ -1,6 +1,4 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Testing](GUI-Testing) > An introduction to unit testing
-
-# Unit Testing
+# An introduction to unit testing
 
 To create unit tests for an Eclipse plug-in a Fragment Project is used. When creating a Fragment Project we assign the plug-in we wish to test as a Host Plug-in.
 Eclipse automatically gives the Fragment access to the classes in the original plug-in.
@@ -218,9 +216,9 @@ From the results it can be seen that 63.2% of the StringManipulator code is used
 The code that isn't used is highlighted in red - for this example we can see that we need to write a test that tests the reverseString method.
 
 
-# Eclipse is complaining
+## Troubleshooting
 
-## ClassNotFoundException
+### ClassNotFoundException
 
 Running the tests in Eclipse might crash with an error like:
 
@@ -244,14 +242,14 @@ This is a known bug and there is a workaround:
 * On the original dialog, click "Apply" and then "Run"
 * Hopefully, the tests will now work and you should be able to re-run them in the normal way
 
-## Eclipse is not picking up new tests
+### Eclipse is not picking up new tests
 
 If Eclipse is not picking up changes when you add tests you may need to change the default output folder for tests for Maven to pick it up.
 
 * Right-click on the tests plug-in, go to properties, Java build path
 * Change the output folder to target/test-classes (you may need to create this folder first by clicking browse, selecting target and adding the test-classes folder)
 * If this does not work try deleting the target/test-classes folder first, if it existed already, and do a clean rebuild of the workspace
 
-## IncompatibleClassChangeError
+### IncompatibleClassChangeError
 
 If the tests are failing because of an IncompatibleClassChangeError error then the solution is to delete the bin and target folders for both the main plug-in and the corresponding test plug-in

doc/uncategorised/GUI_development/Getting_started/Building-the-GUI.md renamed to doc/client/Building-the-GUI.md

@@ -1,4 +1,4 @@
-> [Wiki](Home) > [The GUI](The-GUI) > [Getting started](GUI-Getting-Started) > Building the GUI
+# Building the GUI
 
 Before building and running the GUI please make sure you have followed the steps from here: [First time installing and building (Windows)](First-time-installing-and-building-(Windows)). In particular make sure Git and genie_python are installed.