Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #26106 from open-craft/mavidser/se-3685-hide-help-link

Browse Source 
Add option to disable the help link in the navbar
This commit is contained in:
Sarina Canelake
2021-03-08 10:24:30 -05:00
committed by GitHub
parent 1692081dd0 e66b9e7fff
commit 3cbf7d80f1
6 changed files with 46 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
cms/templates/widgets/header.html
View File

@@ -236,9 +236,11 @@
<nav class="nav-account nav-is-signedin nav-dd ui-right" aria-label="${_('Account')}">
<h2 class="sr-only">${_("Account Navigation")}</h2>
<ol>
<li class="nav-item nav-account-help">
<h3 class="title"><span class="label"><a href="${get_online_help_info(online_help_token)['doc_url']}" title="${_('Contextual Online Help')}" rel="noopener" target="_blank">${_("Help")}</a></span></h3>
</li>
% if settings.FEATURES.get('ENABLE_HELP_LINK'):
<li class="nav-item nav-account-help">
<h3 class="title"><span class="label"><a href="${get_online_help_info(online_help_token)['doc_url']}" title="${_('Contextual Online Help')}" rel="noopener" target="_blank">${_("Help")}</a></span></h3>
</li>
% endif
<li class="nav-item nav-account-user">
<%include file="user_dropdown.html" args="online_help_token=online_help_token" />
</li>

11
lms/envs/common.py
View File

@@ -263,6 +263,17 @@ FEATURES = {
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/1073
'COURSES_ARE_BROWSABLE': True,
# Can be turned off to disable the help link in the navbar
# .. toggle_name: FEATURES['ENABLE_HELP_LINK']
# .. toggle_implementation: DjangoSetting
# .. toggle_default: True
# .. toggle_description: When True, a help link is displayed on the main navbar. Set False to hide it.
# .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2021-03-05
# .. toggle_tickets: https://github.com/edx/edx-platform/pull/26106
'ENABLE_HELP_LINK': True,
# .. toggle_name: FEATURES['HIDE_DASHBOARD_COURSES_UNTIL_ACTIVATED']
# .. toggle_implementation: DjangoSetting
# .. toggle_default: False

9
lms/templates/header/navbar-authenticated.html
View File

@@ -14,6 +14,7 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_
show_explore_courses = settings.FEATURES.get('COURSES_ARE_BROWSABLE')
show_sysadmin_dashboard = settings.FEATURES.get('ENABLE_SYSADMIN_DASHBOARD','') and user.is_staff
self.real_user = getattr(user, 'real_user', user)
enable_help_link = settings.FEATURES.get('ENABLE_HELP_LINK')
support_link = configuration_helpers.get_value('SUPPORT_SITE_LINK', settings.SUPPORT_SITE_LINK)
doc_link = get_online_help_info(online_help_token)['doc_url']
@@ -60,9 +61,11 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_
% endif
</div>
<div class="secondary">
<div class="mobile-nav-item hidden-mobile nav-item">
<a class="help-link" href="${help_link}" rel="noopener" target="_blank">${_("Help")}</a>
</div>
% if enable_help_link:
<div class="mobile-nav-item hidden-mobile nav-item">
<a class="help-link" href="${help_link}" rel="noopener" target="_blank">${_("Help")}</a>
</div>
% endif
<%include file="user_dropdown.html"/>
</div>
</div>

14
lms/templates/navigation/bootstrap/navbar-authenticated.html
View File

@@ -57,12 +57,14 @@ from django.utils.translation import ugettext as _
</ul>
<ul class="navbar-nav navbar-right">
<li class="nav-item mt-2 nav-item-open-collapsed">
<a href="${get_online_help_info(online_help_token)['doc_url']}"
rel="noopener"
target="_blank"
class="nav-link">${_("Help")}</a>
</li>
% if settings.FEATURES.get('ENABLE_HELP_LINK'):
<li class="nav-item mt-2 nav-item-open-collapsed">
<a href="${get_online_help_info(online_help_token)['doc_url']}"
rel="noopener"
target="_blank"
class="nav-link">${_("Help")}</a>
</li>
% endif
<%include file="../../user_dropdown.html"/>
</ul>

10
lms/templates/navigation/navbar-authenticated.html
View File

@@ -41,7 +41,9 @@ from django.utils.translation import ugettext as _
<%include file="../user_dropdown.html"/>
<a href="${get_online_help_info(online_help_token)['doc_url']}"
rel="noopener"
target="_blank"
class="doc-link">${_("Help")}</a>
% if settings.FEATURES.get('ENABLE_HELP_LINK'):
<a href="${get_online_help_info(online_help_token)['doc_url']}"
rel="noopener"
target="_blank"
class="doc-link">${_("Help")}</a>
% endif

17
themes/edx.org/lms/templates/header/navbar-authenticated.html
View File

@@ -14,6 +14,7 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_
show_explore_courses = settings.FEATURES.get('COURSES_ARE_BROWSABLE')
show_sysadmin_dashboard = settings.FEATURES.get('ENABLE_SYSADMIN_DASHBOARD','') and user.is_staff
self.real_user = getattr(user, 'real_user', user)
enable_help_link = settings.FEATURES.get('ENABLE_HELP_LINK')
%>
<div class="nav-links">
@@ -58,13 +59,15 @@ from openedx.core.djangoapps.site_configuration import helpers as configuration_
</div>
<div class="secondary">
<div class="mobile-nav-item hidden-mobile nav-item">
% if online_help_token == "instructor":
<a class="help-link" href="${get_online_help_info(online_help_token)['doc_url']}" rel="noopener" target="_blank">${_("Help")}</a>
% else:
<a class="help-link" href="${configuration_helpers.get_value('SUPPORT_SITE_LINK', settings.SUPPORT_SITE_LINK)}" rel="noopener" target="_blank">${_("Help")}</a>
% endif
</div>
% if enable_help_link:
<div class="mobile-nav-item hidden-mobile nav-item">
% if online_help_token == "instructor":
<a class="help-link" href="${get_online_help_info(online_help_token)['doc_url']}" rel="noopener" target="_blank">${_("Help")}</a>
% else:
<a class="help-link" href="${configuration_helpers.get_value('SUPPORT_SITE_LINK', settings.SUPPORT_SITE_LINK)}" rel="noopener" target="_blank">${_("Help")}</a>
% endif
</div>
% endif
<%include file="user_dropdown.html"/>
</div>
</div>