[UX-491] Rename the blueocean-admin to blueocean-dashboard

README.md

@@ -10,17 +10,13 @@ Yarr...
 # Modules of note
 (check the readme in each of them!)
 
-## blueocean-admin
-
-Example plugin - a starting point. Take a look at it if you want to extend blue ocean. 
-
 ## blueocean-web
 
 BlueOcean Web module, core web module with layout and extention points. You probably want to look at the README for this for how to play with it. This should mostly be infrastructure and core components.
 
-## blueocean-plugin
+## blueocean-dashboard
 
-Wraps up blueocean into a Jenkins plugin to run with an embedded Jenkins, provides implementation of REST interfaces needed for embedded mode. 
+BlueOcean Dashboard plugin. Currently contains the bulk of the Blue Ocean user interface.  
 
 ## blueocean-commons
 
@@ -30,6 +26,14 @@ Common libraries for various modules
 
 Utilities and interfaces for the HTTP api that the Blue Ocean front end needs. 
 
+## blueocean-plugin
+
+This plugin currently fulfills two purposes (and so is likely to be separated out into two plugins - TBD): 
+
+1. Provides the default implementation of the REST Api defined in the `blueocean-rest` plugin.
+1. Acts as an aggregator plugin, making it an easy place from which to run Blue Ocean via `hpi:run`. 
+
+__NOTE__: As already stated, this plugin is likey to be refactored in the near future.
     
 # Building
 

blueocean-dashboard/README.md

@@ -1,9 +1,6 @@
-# Admin plugin
+# Dashboard plugin
 
-This plugin has started as an example of a few extensions.
-The extension points are defined in `blueocean-web`.
-
-However it had become the main app for all client side screens.
+This plugin provides the main Dashboard user interface for Blue Ocean.
 
 ## Running this
 
@@ -158,7 +155,7 @@ I implemented our single source of truth in `blueocean-web/src/main/js/main.jsx`
 
 #### 2. State is read-only - The only way to mutate the state is to emit an action, an object describing what happened.
 
-In `blueocean-admin/src/main/js/redux/actions.js` we have defined all admin related actions. We call some of this actions  e.g. `fetchRunsIfNeeded` from the view e.g. `Activity.jsx`
+In `blueocean-dashboard/src/main/js/redux/actions.js` we have defined all admin related actions. We call some of this actions  e.g. `fetchRunsIfNeeded` from the view e.g. `Activity.jsx`
 
 ```
     componentWillMount() {
@@ -180,7 +177,7 @@ In `blueocean-admin/src/main/js/redux/actions.js` we have defined all admin rela
 
 > Reducers are just pure functions that take the previous state and an action, and return the next state. Remember to return new state objects, instead of mutating the previous state.
 
-`blueocean-admin/src/main/js/redux/reducer.js` here we define all the reducer we are currently using in the admin app and expose them. To follow along the above code snippet from `Activity.jsx` the `fetchRunsIfNeeded` looks like:
+`blueocean-dashboard/src/main/js/redux/reducer.js` here we define all the reducer we are currently using in the admin app and expose them. To follow along the above code snippet from `Activity.jsx` the `fetchRunsIfNeeded` looks like:
 
 ```
     fetchRunsIfNeeded(config) {

blueocean-dashboard/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "blueocean-admin",
+  "name": "blueocean-dashboard",
   "version": "0.0.1",
   "scripts": {
     "storybook": "start-storybook -p 9001 --static-dir node_modules/@jenkins-cd/design-language/dist/assets/",

blueocean-dashboard/pom.xml

@@ -9,8 +9,8 @@
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
-    <name>BlueOcean :: Administration</name>
-    <artifactId>blueocean-admin</artifactId>
+    <name>BlueOcean :: Dashboard</name>
+    <artifactId>blueocean-dashboard</artifactId>
     <packaging>hpi</packaging>
 
     <dependencies>

blueocean-dashboard/src/main/resources/index.jelly

@@ -1,4 +1,4 @@
 <?jelly escape-by-default='true'?>
 <div>
-  Blue Ocean Administration
+  Blue Ocean Dashboard
 </div>

blueocean-plugin/pom.xml

@@ -17,7 +17,7 @@
     <dependencies>
         <dependency>
             <groupId>${project.groupId}</groupId>
-            <artifactId>blueocean-admin</artifactId>
+            <artifactId>blueocean-dashboard</artifactId>
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
@@ -191,7 +191,7 @@
                         // Link in other sub-modules. Add as needed.
                         //
                         linkHPI('blueocean-web');
-                        linkHPI('blueocean-admin'); // Test plugin
+                        linkHPI('blueocean-dashboard');
                         linkHPI('blueocean-rest');
                         linkHPI('blueocean-commons');
                     </source>

blueocean-plugin/src/test/java/io/jenkins/blueocean/jsextensions/JenkinsJSExtensionsTest.java

@@ -38,12 +38,12 @@ public class JenkinsJSExtensionsTest extends BaseTest{
     @Test
     public void test() {
         // FIXME: This test relies on configuration in a separate project
-        // Simple test of the rest endpoint. It should find the "blueocean-admin"
+        // Simple test of the rest endpoint. It should find the "blueocean-dashboard"
         // plugin ExtensionPoint contributions.
         List<Map> extensions = get("/javaScriptExtensionInfo", List.class);
 
         Assert.assertEquals(1, extensions.size());
-        Assert.assertEquals("blueocean-admin", extensions.get(0).get("hpiPluginId"));
+        Assert.assertEquals("blueocean-dashboard", extensions.get(0).get("hpiPluginId"));
 
         List<Map> ext = (List<Map>) extensions.get(0).get("extensions");
 

blueocean-web/README.md

@@ -5,7 +5,7 @@ Look for blueocean.js for excitement.
 
 # Running Blue Ocean in development
 
-If you want to add to some extension points, take a look at the blueocean-admin module (actually a plugin) for an example.
+If you want to add to some extension points, take a look at the `blueocean-dashboard` module (actually a plugin) for an example.
 
 ## Firstly build all modules from root
 
@@ -16,7 +16,7 @@ If you want to add to some extension points, take a look at the blueocean-admin
 ## Run it in plugin dev mode
 
 To hack on blue ocean UI, you will want to run it embedded in a Jenkins you can add jobs to and so on. 
-To do this, use the blueocean-plugin module: 
+To do this, use the `blueocean-plugin` module: 
 
     cd blueocean-plugin
     mvn hpi:run
@@ -51,7 +51,7 @@ $ cd blueocean-web
 $ gulp bundle:watch
 ```
 
-(or run gulp, after each change) in the blueocean-web directory. This will pick up any changes. 
+(or run gulp, after each change) in the `blueocean-web` directory. This will pick up any changes. 
 If you are editing any other UI modules, run the same in their respective directories. 
 
 

blueocean-web/src/test/js/blueocean-spec.js

@@ -26,7 +26,7 @@ describe('blueocean.js', () => {
             expect(loads[1]).toBe('http://localhost:18999/target/classes/io/jenkins/blueocean/no_imports/blueocean.js');
 
             expect(loads[2]).toBe('http://localhost:18999/src/test/resources/blue/javaScriptExtensionInfo');
-            //expect(loads[3]).toBe('http://localhost:18999/src/test/resources/mock-adjuncts/io/jenkins/blueocean-admin/jenkins-js-extension.js');
+            //expect(loads[3]).toBe('http://localhost:18999/src/test/resources/mock-adjuncts/io/jenkins/blueocean-dashboard/jenkins-js-extension.js');
 
             // Check for some of the elements. We know that the following should
             // be rendered by the React components.

checkdeps.js

@@ -37,7 +37,7 @@ function initEntry(dependency, version) {
 
 var packageFiles = [];
 
-packageFiles.push(require("./blueocean-admin/package.json"));
+packageFiles.push(require("./blueocean-dashboard/package.json"));
 packageFiles.push(require("./blueocean-web/package.json"));
 
 packageFiles.forEach(packageFile => {

pom.xml

@@ -25,9 +25,9 @@
 
   <modules>
     <module>blueocean-commons</module>
-    <module>blueocean-rest</module>
     <module>blueocean-web</module>
-    <module>blueocean-admin</module>
+    <module>blueocean-rest</module>
+    <module>blueocean-dashboard</module>
     <module>blueocean-plugin</module>
   </modules>
 
@@ -75,7 +75,7 @@
 
         <dependency>
             <groupId>${project.groupId}</groupId>
-            <artifactId>blueocean-admin</artifactId>
+            <artifactId>blueocean-dashboard</artifactId>
             <version>${project.version}</version>
         </dependency>