Navigation Menu

Skip to content

Commit

Permalink
Fix #669
Browse files Browse the repository at this point in the history
  • Loading branch information
gashcrumb committed Oct 23, 2013
1 parent 62ba514 commit 7a9797c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
12 changes: 6 additions & 6 deletions hawtio-web/src/main/webapp/app/core/doc/overview.md
@@ -1,11 +1,11 @@
### Welcome to <img class='no-shadow' src='img/logo.png'>hawtio ###
<h3 class="help-header">Welcome to <img class='no-shadow' ng-src='{{branding.appLogo}}'>{{branding.appName}} </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>hawtio</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
<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 [hawtio](http://hawt.io "hawtio") is via the top navigation bar.
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")

Expand All @@ -14,7 +14,7 @@ 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 [hawtio](http://hawt.io "hawtio")'s help system. Browse the available help topics for plugin-specific documentation using the help navigation bar on the left.
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")

Expand All @@ -26,10 +26,10 @@ Available sub-topics for each plugin can be selected via the secondary navigatio
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 [hawtio](http://hawt.io "hawtio") 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.
- **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 [hawtio](http://hawt.io "hawtio") detects a change in available plugins.
- **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 ######
Expand Down
4 changes: 3 additions & 1 deletion hawtio-web/src/main/webapp/app/core/js/help.ts
@@ -1,5 +1,7 @@
module Core {
export function HelpController($scope, $routeParams, marked, helpRegistry) {
export function HelpController($scope, $routeParams, marked, helpRegistry, branding) {

$scope.branding = branding;

$scope.topics = helpRegistry.getTopics();
$scope.topic = $routeParams.topic;
Expand Down
15 changes: 15 additions & 0 deletions hawtio-web/src/main/webapp/css/site-branding.css
Expand Up @@ -796,3 +796,18 @@ div[ng-controller="Log.LogController"] .logbar .logbar-container {
border-bottom: 1px solid #cecdcd !important;
}

.help-header {
background-color: #393F45;
color: white;
padding-left: 10px;
padding-right: 10px;
border-radius: 4px;
}

.help-header img {
position: relative;
margin-right: 7px;
margin-left: 3px;
height: 22px;
top: -2px;
}

0 comments on commit 7a9797c

Please sign in to comment.