#832: Preference has its own help page.

hawtio · Dec 12, 2013 · 385d141 · 385d141
1 parent fe20737
commit 385d141
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 54 deletions.
diff --git a/hawtio-web/src/main/webapp/app/core/doc/img/help-preference.png b/hawtio-web/src/main/webapp/app/core/doc/img/help-preference.png
diff --git a/hawtio-web/src/main/webapp/app/core/doc/img/help-topic-nav.png b/hawtio-web/src/main/webapp/app/core/doc/img/help-topic-nav.png
diff --git a/hawtio-web/src/main/webapp/app/core/doc/overview.md b/hawtio-web/src/main/webapp/app/core/doc/overview.md
@@ -1,19 +1,6 @@
-<h3 class="help-header">Welcome to <img class='no-shadow' ng-src='{{branding.appLogo}}'>{{branding.appName}} </h3>
+<h3 class="help-header">Welcome to <img class='no-shadow' ng-src='{{branding.appLogo}}'>{{branding.appName}} Help</h3>
 
-Don't cha wish your console was <a href="http://www.youtube.com/watch?v=YNSxNsr4wmA">hawt like me</a>? I'm <i>hawt</i> so you can stay cool!
-
-<b>{{branding.appName}}</b> is a lightweight and <a href="http://hawt.io/plugins/index.html">modular</a> HTML5 web console with <a href="http://hawt.io/plugins/index.html">lots of plugins</a> for managing your Java stuff
-
-##### General Navigation #####
-Primary navigation in [{{branding.appName}}](http://hawt.io "{{branding.appName}}") is via the top navigation bar.
-
-![Main Navigation Bar](app/core/doc/img/main-nav.png "Main Navigation Bar")
-
-Clicking on a navigation link will take you to that plugin's main page.
-
-<i class='yellow text-shadowed icon-warning-sign'></i> **Note:** The available links in the navigation bar depend on what plugins are available and what JMX MBeans are available in the JVM, and so may differ from what is shown here.
-
-##### Getting Help #####
+##### Plugin Help #####
 Click the Help icon (<i class='icon-question-sign'></i>) in the main navigation bar to access [{{branding.appName}}](http://hawt.io "{{branding.appName}}")'s help system. Browse the available help topics for plugin-specific documentation using the help navigation bar on the left.
 
 ![Help Topic Navigation Bar](app/core/doc/img/help-topic-nav.png "Help Topic Navigation Bar")
@@ -23,38 +10,14 @@ Available sub-topics for each plugin can be selected via the secondary navigatio
 ![Help Sub-Topic Navigation Bar](app/core/doc/img/help-subtopic-nav.png "Help Sub-Topic Navigation Bar")
 
 ##### Preferences #####
-Click the Preferences icon (<i class='icon-cogs'></i>) in the main navigation bar to access the [Preferences](#/preferences) page.  Available configuration options include, but not limited to:
-
-###### Behaviour ######
-- **Update Rate** - How often [{{branding.appName}}](http://hawt.io "{{branding.appName}}") polls the [Jolokia](http://jolokia.org) backend for JMX metrics.  Can be set to "No Refreshes" and intervals of 1, 2, 5, 10, and 30 seconds.
-
-  <i class='yellow text-shadowed icon-warning-sign'></i> **Note:** Setting this to "No Refreshes" will disable charting, as charting requires fetching periodic metric updates.
-- **Auto Refresh** - Automatically refresh the browser window if [{{branding.appName}}](http://hawt.io "{{branding.appName}}") detects a change in available plugins.
-- **Host Identification** - To associate a label and colour to host(s) when [connecting](#/help/jvm) to containers.
-
-###### Logs ######
-- **Log cache size** - How many log lines to cache in the [Logs](#/help/log) plugin.
-
-###### Git ######
-- **User Name** - The git username to use when committing updates to the [Dashboard](#/help/dashboard/) or [Wiki](#/help/wiki).
-- **Email address** - The e-mail address to associate with git commits.
-
-###### ActiveMQ ######
-- **User Name** - The username to use when connecting to the [ActiveMQ](#/help/activemq/) broker.
-- **Password** - The password for the username.
-
-###### Editor ######
-- **Theme** - The theme to be used by the CodeMirror code editor
-- **Tab Size** - The tab stop size to be used by the CodeMirror code editor.
+The [Preferences](#/preferences) is accessible by clicking the user icon (<i class='icon-user'></i>) in the main navigation bar,
+and then clicking the Preferences icon (<i class='icon-cogs'></i>), as shown below:
 
+![Preference](app/core/doc/img/help-preference.png "Preference")
 
 ##### Further Reading #####
 - [hawtio](http://hawt.io "hawtio") website
 - Chat with the hawtio team on IRC by joining **#hawtio** on **irc.freenode.net**
 - Help improve [hawtio](http://hawt.io "hawtio") by [contributing](http://hawt.io/contributing/index.html)
 - [hawtio on github](https://github.com/hawtio/hawtio)
 
-
-
-
-
diff --git a/hawtio-web/src/main/webapp/app/core/doc/preference.md b/hawtio-web/src/main/webapp/app/core/doc/preference.md
@@ -0,0 +1,33 @@
+### Preference
+
+The preference is used to configure **hawtio** and the plugins.
+
+##### Core #####
+
+###### Behaviour ######
+- **Welcome Page** - Whether to show welcome page on startup.
+- **Update Rate** - How often [{{branding.appName}}](http://hawt.io "{{branding.appName}}") polls the [Jolokia](http://jolokia.org) backend for JMX metrics.  Can be set to "No Refreshes" and intervals of 1, 2, 5, 10, and 30 seconds.
+
+  <i class='yellow text-shadowed icon-warning-sign'></i> **Note:** Setting this to "No Refreshes" will disable charting, as charting requires fetching periodic metric updates.
+- **Auto Refresh** - Automatically refresh the browser window if [{{branding.appName}}](http://hawt.io "{{branding.appName}}") detects a change in available plugins.
+- **Host Identification** - To associate a label and colour to host(s) when [connecting](#/help/jvm) to containers.
+
+###### Logs ######
+- **Log cache size** - How many log lines to cache in the [Logs](#/help/log) plugin.
+
+###### Git ######
+- **User Name** - The git username to use when committing updates to the [Dashboard](#/help/dashboard/) or [Wiki](#/help/wiki).
+- **Email address** - The e-mail address to associate with git commits.
+
+###### ActiveMQ ######
+- **User Name** - The username to use when connecting to the [ActiveMQ](#/help/activemq/) broker.
+- **Password** - The password for the username.
+
+###### Editor ######
+- **Theme** - The theme to be used by the CodeMirror code editor
+- **Tab Size** - The tab stop size to be used by the CodeMirror code editor.
+
+
+##### Camel #####
+
+TODO: Some options here
diff --git a/hawtio-web/src/main/webapp/app/core/doc/welcome.md b/hawtio-web/src/main/webapp/app/core/doc/welcome.md
@@ -11,19 +11,15 @@ Primary navigation in [{{branding.appName}}](http://hawt.io "{{branding.appName}
 
 Clicking on a navigation link will take you to that plugin's main page.
 
-<i class='yellow text-shadowed icon-warning-sign'></i> **Note:** The available links in the navigation bar depend on what plugins are available and what JMX MBeans are available in the JVM, and so may differ from what is shown here.
-
 ##### Getting Help #####
-Click the Help icon (<i class='icon-question-sign'></i>) in the main navigation bar to access [{{branding.appName}}](http://hawt.io "{{branding.appName}}")'s help system. Browse the available help topics for plugin-specific documentation using the help navigation bar on the left.
-
-![Help Topic Navigation Bar](app/core/doc/img/help-topic-nav.png "Help Topic Navigation Bar")
-
-Available sub-topics for each plugin can be selected via the secondary navigation bar above the help display area.
-
-![Help Sub-Topic Navigation Bar](app/core/doc/img/help-subtopic-nav.png "Help Sub-Topic Navigation Bar")
+Click the Help icon (<i class='icon-question-sign'></i>) in the main navigation bar to access [{{branding.appName}}](http://hawt.io "{{branding.appName}}")'s help system.
+Browse the available help topics for plugin-specific documentation using the help navigation bar on the left.
 
 ##### Preferences #####
-Click the Preferences icon (<i class='icon-cogs'></i>) in the main navigation bar to access the [Preferences](#/preferences) page.  Available configuration options include, but not limited to:
+The [Preferences](#/preferences) is accessible by clicking the user icon (<i class='icon-user'></i>) in the main navigation bar,
+and then clicking the Preferences icon (<i class='icon-cogs'></i>).
+
+In the Preferences you can among others configure whether to show this welcome page on startup or not.
 
 
 
diff --git a/hawtio-web/src/main/webapp/app/core/js/corePlugin.ts b/hawtio-web/src/main/webapp/app/core/js/corePlugin.ts
@@ -412,6 +412,7 @@ angular.module(Core.pluginName, ['bootstrap', 'ngResource', 'ui', 'ui.bootstrap.
           viewRegistry['login'] = layoutFull;
 
           helpRegistry.addUserDoc('index', 'app/core/doc/overview.md');
+          helpRegistry.addUserDoc('preference', 'app/core/doc/preference.md');
           helpRegistry.addSubTopic('index', 'faq', 'app/core/doc/FAQ.md');
           helpRegistry.addSubTopic('index', 'changes', 'app/core/doc/CHANGES.md');
           helpRegistry.addSubTopic('index', 'developer', 'app/core/doc/developer.md');

diff --git a/hawtio-web/src/main/webapp/app/core/js/welcome.ts b/hawtio-web/src/main/webapp/app/core/js/welcome.ts
@@ -8,10 +8,9 @@ module Core {
     var log:Logging.Logger = Logger.get("Welcome");
 
     $scope.stopShowingWelcomePage = () => {
-      log.info("Stop showing welcome page");
+      log.debug("Stop showing welcome page");
       localStorage['showWelcomePage'] = false;
 
-      log.info("Redirecting to default page");
       $location.path("/");
     };