added HelpCenter to Site Settings (#5594)

* added HelpCenter to Site Settings so user can configure their own help center link * fixed navbar to use non admin useSiteSetting * removing default help center link to greenlight and hiding nav icon if not set * added migration for adding help center to setting and site_setting * fixed rubocop errors for migration * removed helpcenter migration clash from populate setting and site setting data * combined HelpCenter migrations for simplicity --------- Co-authored-by: Ahmad Farhat <[email protected]>
bigbluebutton · Dec 18, 2023 · 05b144b · 05b144b
1 parent 5da6789
commit 05b144b
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 9 deletions.
diff --git a/app/assets/locales/en.json b/app/assets/locales/en.json
@@ -274,6 +274,8 @@
         "privacy_policy": "Privacy Policy",
         "change_term_links": "Change the terms links that appears at the bottom of the page",
         "change_privacy_link": "Change the privacy link that appears at the bottom of the page",
+        "helpcenter": "Help center",
+        "change_helpcenter_link": "Change the help center link that appears under the profile dropdown",
         "change_url": "Change URL",
         "enter_link": "Enter link here"
       },
@@ -398,6 +400,7 @@
         "brand_image_updated": "The brand image has been updated.",
         "brand_image_deleted": "The brand image has been deleted.",
         "privacy_policy_updated": "The privacy policy has been updated.",
+        "helpcenter_updated": "The help center link has been updated.",
         "terms_of_service_updated": "The terms of service have been updated."
       },
       "recording": {

diff --git a/app/javascript/components/admin/site_settings/administration/Administration.jsx b/app/javascript/components/admin/site_settings/administration/Administration.jsx
@@ -23,7 +23,7 @@ import useSiteSettings from '../../../../hooks/queries/admin/site_settings/useSi
 
 export default function Administration() {
   const { t } = useTranslation();
-  const { data: siteSettings } = useSiteSettings(['Terms', 'PrivacyPolicy']);
+  const { data: siteSettings } = useSiteSettings(['Terms', 'PrivacyPolicy', 'HelpCenter']);
 
   return (
     <>
@@ -45,6 +45,15 @@ export default function Administration() {
           value={siteSettings?.PrivacyPolicy}
         />
       </Row>
+      <Row>
+        <h6> { t('admin.site_settings.administration.helpcenter') } </h6>
+        <p className="text-muted"> { t('admin.site_settings.administration.change_helpcenter_link') } </p>
+        <LinksForm
+          id="helpForm"
+          mutation={() => useUpdateSiteSetting('HelpCenter')}
+          value={siteSettings?.HelpCenter}
+        />
+      </Row>
     </>
   );
 }
diff --git a/app/javascript/components/home/NavbarSignedIn.jsx b/app/javascript/components/home/NavbarSignedIn.jsx
@@ -25,10 +25,12 @@ import PropTypes from 'prop-types';
 import { ChevronDownIcon } from '@heroicons/react/20/solid';
 import useDeleteSession from '../../hooks/mutations/sessions/useDeleteSession';
 import Avatar from '../users/user/Avatar';
+import useSiteSetting from '../../hooks/queries/site_settings/useSiteSetting';
 
 export default function NavbarSignedIn({ currentUser }) {
   const { t } = useTranslation();
   const deleteSession = useDeleteSession({ showToast: true });
+  const { data: helpCenter } = useSiteSetting('HelpCenter');
 
   const adminAccess = () => {
     const { permissions } = currentUser;
@@ -61,10 +63,15 @@ export default function NavbarSignedIn({ currentUser }) {
             <IdentificationIcon className="hi-s me-3" />
             {t('user.profile.profile')}
           </Nav.Link>
-          <Nav.Link eventKey={2} href="https://docs.bigbluebutton.org/greenlight/v3/install">
-            <QuestionMarkCircleIcon className="hi-s me-3" />
-            {t('help_center')}
-          </Nav.Link>
+          {
+            helpCenter
+            && (
+              <Nav.Link eventKey={2} href={helpCenter}>
+                <QuestionMarkCircleIcon className="hi-s me-3" />
+                {t('help_center')}
+              </Nav.Link>
+            )
+          }
           {
             adminAccess()
             && (
@@ -103,10 +110,15 @@ export default function NavbarSignedIn({ currentUser }) {
             <IdentificationIcon className="hi-s me-3" />
             { t('user.profile.profile') }
           </NavDropdown.Item>
-          <NavDropdown.Item href="https://docs.bigbluebutton.org/greenlight/v3/install">
-            <QuestionMarkCircleIcon className="hi-s me-3" />
-            {t('help_center')}
-          </NavDropdown.Item>
+          {
+            helpCenter
+            && (
+              <NavDropdown.Item href={helpCenter}>
+                <QuestionMarkCircleIcon className="hi-s me-3" />
+                {t('help_center')}
+              </NavDropdown.Item>
+            )
+          }
           {
             adminAccess()
             && (

diff --git a/app/javascript/hooks/mutations/admin/site_settings/useUpdateSiteSetting.jsx b/app/javascript/hooks/mutations/admin/site_settings/useUpdateSiteSetting.jsx
@@ -54,6 +54,9 @@ export default function useUpdateSiteSetting(name) {
       case 'PrivacyPolicy':
         toast.success(t('toast.success.site_settings.privacy_policy_updated'));
         break;
+      case 'HelpCenter':
+        toast.success(t('toast.success.site_settings.helpcenter_updated'));
+        break;
       case 'TermsOfService':
         toast.success(t('toast.success.site_settings.terms_of_service_updated'));
         break;

diff --git a/app/services/tenant_setup.rb b/app/services/tenant_setup.rb
@@ -47,6 +47,7 @@ def create_site_settings
         provider: @provider },
       { setting: Setting.find_by(name: 'Terms'), value: '', provider: @provider },
       { setting: Setting.find_by(name: 'PrivacyPolicy'), value: '', provider: @provider },
+      { setting: Setting.find_by(name: 'HelpCenter'), value: '', provider: @provider },
       { setting: Setting.find_by(name: 'RegistrationMethod'), value: SiteSetting::REGISTRATION_METHODS[:open],
         provider: @provider },
       { setting: Setting.find_by(name: 'ShareRooms'), value: 'true', provider: @provider },

diff --git a/db/migrate/20231218154727_add_help_center_setting.rb b/db/migrate/20231218154727_add_help_center_setting.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class AddHelpCenterSetting < ActiveRecord::Migration[7.1]
+  def up
+    Setting.create!(name: 'HelpCenter') unless Setting.exists?(name: 'HelpCenter')
+
+    return if SiteSetting.exists?(setting: Setting.find_by(name: 'HelpCenter'))
+
+    SiteSetting.create!(
+      setting: Setting.find_by(name: 'HelpCenter'),
+      value: '',
+      provider: 'greenlight'
+    )
+  end
+
+  def down
+    Setting.find_by(name: 'HelpCenter')&.destroy
+    SiteSetting.find_by(setting: Setting.find_by(name: 'HelpCenter')).destroy
+  end
+end
diff --git a/spec/controllers/admin/tenants_controller_spec.rb b/spec/controllers/admin/tenants_controller_spec.rb
@@ -136,6 +136,7 @@ def create_settings_permissions_meetingoptions
     Setting.find_or_create_by(name: 'BrandingImage')
     Setting.find_or_create_by(name: 'Terms')
     Setting.find_or_create_by(name: 'PrivacyPolicy')
+    Setting.find_or_create_by(name: 'HelpCenter')
     Setting.find_or_create_by(name: 'RegistrationMethod')
     Setting.find_or_create_by(name: 'ShareRooms')
     Setting.find_or_create_by(name: 'PreuploadPresentation')