Add optional Report Bug link to Horizon

Change-Id: I2d0053adbdfcb196683c709f755f778427e6109b
Closes-Bug: #1499476

doc/source/topics/settings.rst

@@ -147,6 +147,17 @@ If provided, will auto-fade the alert types specified. Valid alert types
 include: ['alert-success', 'alert-info', 'alert-warning', 'alert-error']
 Can also define the delay before the alert fades and the fade out duration.
 
+``bug_url``
+------------
+
+.. versionadded:: 9.0.0(Mitaka)
+
+Default: ``None``
+
+If provided, a "Report Bug" link will be displayed in the site header which
+links to the value of this setting (ideally a URL containing information on
+how to report issues).
+
 ``help_url``
 ------------
 
@@ -155,7 +166,7 @@ Can also define the delay before the alert fades and the fade out duration.
 Default: ``None``
 
 If provided, a "Help" link will be displayed in the site header which links
-to the value of this settings (ideally a URL containing help information).
+to the value of this setting (ideally a URL containing help information).
 
 ``exceptions``
 --------------

horizon/conf/default.py

@@ -28,6 +28,9 @@ HORIZON_CONFIG = {
     'ajax_queue_limit': 10,
     'ajax_poll_interval': 2500,
 
+    # URL for reporting issue with this site.
+    'bug_url': None,
+
     # URL for additional help with this site.
     'help_url': None,
 

horizon/test/settings.py

@@ -137,6 +137,7 @@ HORIZON_CONFIG = {
         "help_text": "Password must be between 8 and 18 characters."
     },
     'user_home': None,
+    'bug_url': None,
     'help_url': "http://example.com",
 }
 

openstack_dashboard/local/local_settings.py.example

@@ -68,6 +68,11 @@ WEBROOT = '/'
 # Set to None explicitly if you want to deactivate the console.
 #CONSOLE_TYPE = "AUTO"
 
+# If provided, a "Report Bug" link will be displayed in the site header
+# which links to the value of this setting (ideally a URL containing
+# information on how to report issues).
+#HORIZON_CONFIG["bug_url"] = "http://bug-report.example.com"
+
 # Show backdrop element outside the modal, do not close the modal
 # after clicking on backdrop.
 #HORIZON_CONFIG["modal_backdrop"] = "static"

openstack_dashboard/settings.py

@@ -60,6 +60,7 @@ HORIZON_CONFIG = {
         'fade_duration': 1500,
         'types': ['alert-success', 'alert-info']
     },
+    'bug_url': None,
     'help_url': "http://docs.openstack.org",
     'exceptions': {'recoverable': exceptions.RECOVERABLE,
                    'not_found': exceptions.NOT_FOUND,

openstack_dashboard/templates/500.html

@@ -71,6 +71,9 @@
       <div id="links">
         {% block links %}
         <p><a href="{{ CONF.WEBROOT }}">{% trans "Home" %}</a></p>
+        {% if CONF.HORIZON_CONFIG.bug_url %}
+        <p><a href="{{ CONF.HORIZON_CONFIG.bug_url }}">{% trans "Report Bug" %}</a></p>
+        {% endif %}
         <p><a href="{{ CONF.HORIZON_CONFIG.help_url }}">{% trans "Help" %}</a></p>
         {% endblock %}
       </div>

openstack_dashboard/templates/_header.html

@@ -67,6 +67,14 @@
                 {% trans "Settings" %}
               </a>
             </li>
+            {% if HORIZON_CONFIG.bug_url %}
+              <li>
+                <a href="{{ HORIZON_CONFIG.bug_url }}" target="_blank">
+                  <span class="fa fa-bug"></span>
+                  {% trans "Report Bug" %}
+                </a>
+              </li>
+            {% endif %}
             {% if HORIZON_CONFIG.help_url %}
               <li>
                 <a href="{{ HORIZON_CONFIG.help_url }}" target="_blank">

openstack_dashboard/themes/material/templates/_header.html

@@ -76,6 +76,14 @@
                 {% trans "Settings" %}
               </a>
             </li>
+            {% if HORIZON_CONFIG.bug_url %}
+              <li>
+                <a href="{{ HORIZON_CONFIG.bug_url }}" target="_blank">
+                  <span class="fa fa-bug"></span>
+                  {% trans "Report Bug" %}
+                </a>
+              </li>
+            {% endif %}
             {% if HORIZON_CONFIG.help_url %}
               <li>
                 <a href="{{ HORIZON_CONFIG.help_url }}" target="_blank">