Change help button to point to Google help page

In order for the change to come into effect, one must set the GGRC_EXTRENAL_HELP_URL environment variable and re-deploy the application settings.
HLD · Nov 10, 2016 · f32a2d2 · f32a2d2
1 parent 4feb91e
commit f32a2d2
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -179,6 +179,7 @@ src/app.yaml : src/app.yaml.dist
 		CUSTOM_URL_ROOT="$(CUSTOM_URL_ROOT)" \
 		ABOUT_URL="$(ABOUT_URL)" \
 		ABOUT_TEXT="$(ABOUT_TEXT)" \
+		EXTERNAL_HELP_URL="$(EXTERNAL_HELP_URL)" \
 		INSTANCE_CLASS="$(INSTANCE_CLASS)" \
 		MAX_INSTANCES="$(MAX_INSTANCES)" \
 		AUTHORIZED_DOMAINS="$(AUTHORIZED_DOMAINS)"

diff --git a/bin/deploy_appengine b/bin/deploy_appengine
@@ -34,6 +34,7 @@ make deploy \
 	CUSTOM_URL_ROOT="${CUSTOM_URL_ROOT}" \
 	ABOUT_URL="${ABOUT_URL}" \
 	ABOUT_TEXT="${ABOUT_TEXT}" \
+	EXTERNAL_HELP_URL="${EXTERNAL_HELP_URL}" \
 	INSTANCE_CLASS="${INSTANCE_CLASS}" \
 	MAX_INSTANCES="${MAX_INSTANCES}" \
 	AUTHORIZED_DOMAINS="${AUTHORIZED_DOMAINS}"
diff --git a/bin/init_vagrant_env b/bin/init_vagrant_env
@@ -1,4 +1,5 @@
 export DEV_PREFIX=/vagrant-dev
+export GGRC_EXTERNAL_HELP_URL='#set_GGRC_EXTERNAL_HELP_URL_env_var'
 
 echo "Initializing environment"
 cd /vagrant

diff --git a/extras/deploy_settings_local.sh b/extras/deploy_settings_local.sh
@@ -15,5 +15,6 @@ RISK_ASSESSMENT_URL='http://localhost:8080'
 CUSTOM_URL_ROOT=''
 ABOUT_URL='#'
 ABOUT_TEXT='About gGRC'
+EXTERNAL_HELP_URL='#set_GGRC_EXTERNAL_HELP_URL_env_var'
 INSTANCE_CLASS='B4'
 MAX_INSTANCES='4'
diff --git a/src/app.yaml.dist b/src/app.yaml.dist
@@ -87,5 +87,6 @@ env_variables:
   GGRC_CUSTOM_URL_ROOT: "{CUSTOM_URL_ROOT}"
   GGRC_ABOUT_URL: "{ABOUT_URL}"
   GGRC_ABOUT_TEXT: "{ABOUT_TEXT}"
+  GGRC_EXTERNAL_HELP_URL: "{EXTERNAL_HELP_URL}"
   MAX_INSTANCES: "{MAX_INSTANCES}"
   AUTHORIZED_DOMAINS: "{AUTHORIZED_DOMAINS}"
diff --git a/src/ggrc/assets/mustache/base_objects/page_header.mustache b/src/ggrc/assets/mustache/base_objects/page_header.mustache
@@ -123,7 +123,7 @@
     </ul>
   </li>
   <li>
-    <a href="javascript://" id="#page-help" data-toggle="modal-ajax-helpform" data-help-slug="{{self.page_help()|trim}}">
+    <a id="#page-help" href="{{GGRC.config.external_help_url}}" target="_blank">
       <i class="fa fa-question-circle"></i>
       <span>Help</span>
     </a>

diff --git a/src/ggrc/settings/__init__.py b/src/ggrc/settings/__init__.py
@@ -28,6 +28,7 @@
 CUSTOM_URL_ROOT = os.environ.get("GGRC_CUSTOM_URL_ROOT")
 ABOUT_URL = os.environ.get("GGRC_ABOUT_URL")
 ABOUT_TEXT = os.environ.get("GGRC_ABOUT_TEXT")
+EXTERNAL_HELP_URL = os.environ.get("GGRC_EXTERNAL_HELP_URL")
 
 if len(SETTINGS_MODULE.strip()) == 0:
   raise RuntimeError("Specify your settings using the `GGRC_SETTINGS_MODULE` "

diff --git a/src/ggrc/views/__init__.py b/src/ggrc/views/__init__.py
@@ -46,6 +46,9 @@
 from ggrc.utils import benchmark
 
 
+EXTERNAL_HELP_URL = getattr(settings, "EXTERNAL_HELP_URL", "")
+
+
 # Needs to be secured as we are removing @login_required
 
 @app.route("/_background_tasks/reindex", methods=["POST"])
@@ -102,10 +105,14 @@ def get_config_json():
   """Get public app config"""
   with benchmark("Get config JSON"):
     public_config = dict(app.config.public_config)
+
     for extension_module in get_extension_modules():
       if hasattr(extension_module, 'get_public_config'):
         public_config.update(
             extension_module.get_public_config(get_current_user()))
+
+    public_config['external_help_url'] = EXTERNAL_HELP_URL
+
     return json.dumps(public_config)