From 0ad1c02932314585aa3ab751e9df043c359cc3c9 Mon Sep 17 00:00:00 2001
From: Osama Sayegh <asooomaasoooma90@gmail.com>
Date: Thu, 31 Oct 2024 10:04:31 +0300
Subject: [PATCH] FEATURE: Add 'Community title' field to about config page
 (#29500)

This commit adds a new "Community title" field to the about config page. This field controls the `short_site_description` setting, which is shown in the browser tab for key pages such categories pages and topic lists.

Internal topic: t/140812.
---
 .../about/general-settings.gjs                       | 12 ++++++++++++
 .../addon/components/admin-config-areas/about.gjs    |  1 +
 .../admin/addon/routes/admin-config-about.js         |  1 +
 app/controllers/admin/config/about_controller.rb     |  1 +
 config/locales/client.en.yml                         |  2 ++
 spec/system/admin_about_config_area_spec.rb          |  8 ++++++++
 .../admin_about_config_area_general_settings_card.rb |  4 ++++
 7 files changed, 29 insertions(+)

diff --git a/app/assets/javascripts/admin/addon/components/admin-config-area-cards/about/general-settings.gjs b/app/assets/javascripts/admin/addon/components/admin-config-area-cards/about/general-settings.gjs
index 744162d95ac..7ba26e0b715 100644
--- a/app/assets/javascripts/admin/addon/components/admin-config-area-cards/about/general-settings.gjs
+++ b/app/assets/javascripts/admin/addon/components/admin-config-area-cards/about/general-settings.gjs
@@ -23,6 +23,7 @@ export default class AdminConfigAreasAboutGeneralSettings extends Component {
       summary: this.args.generalSettings.siteDescription.value,
       extendedDescription:
         this.args.generalSettings.extendedSiteDescription.value,
+      communityTitle: this.args.generalSettings.communityTitle.value,
       aboutBannerImage: this.args.generalSettings.aboutBannerImage.value,
     };
   }
@@ -38,6 +39,7 @@ export default class AdminConfigAreasAboutGeneralSettings extends Component {
             name: data.name,
             summary: data.summary,
             extended_description: data.extendedDescription,
+            community_title: data.communityTitle,
             about_banner_image: data.aboutBannerImage,
           },
         },
@@ -95,6 +97,16 @@ export default class AdminConfigAreasAboutGeneralSettings extends Component {
         <field.Composer />
       </form.Field>
 
+      <form.Field
+        @name="communityTitle"
+        @title={{i18n "admin.config_areas.about.community_title"}}
+        @description={{i18n "admin.config_areas.about.community_title_help"}}
+        @format="large"
+        as |field|
+      >
+        <field.Input />
+      </form.Field>
+
       <form.Field
         @name="aboutBannerImage"
         @title={{i18n "admin.config_areas.about.banner_image"}}
diff --git a/app/assets/javascripts/admin/addon/components/admin-config-areas/about.gjs b/app/assets/javascripts/admin/addon/components/admin-config-areas/about.gjs
index cba24040171..5c724b2c6b6 100644
--- a/app/assets/javascripts/admin/addon/components/admin-config-areas/about.gjs
+++ b/app/assets/javascripts/admin/addon/components/admin-config-areas/about.gjs
@@ -16,6 +16,7 @@ export default class AdminConfigAreasAbout extends Component {
       extendedSiteDescription: this.#lookupSettingFromData(
         "extended_site_description"
       ),
+      communityTitle: this.#lookupSettingFromData("short_site_description"),
       aboutBannerImage: this.#lookupSettingFromData("about_banner_image"),
     };
   }
diff --git a/app/assets/javascripts/admin/addon/routes/admin-config-about.js b/app/assets/javascripts/admin/addon/routes/admin-config-about.js
index 5eff95861ea..48832b9e829 100644
--- a/app/assets/javascripts/admin/addon/routes/admin-config-about.js
+++ b/app/assets/javascripts/admin/addon/routes/admin-config-about.js
@@ -9,6 +9,7 @@ export default class AdminConfigAboutRoute extends Route {
           "title",
           "site_description",
           "extended_site_description",
+          "short_site_description",
           "about_banner_image",
           "community_owner",
           "contact_email",
diff --git a/app/controllers/admin/config/about_controller.rb b/app/controllers/admin/config/about_controller.rb
index b3b86120b71..a2c75f51740 100644
--- a/app/controllers/admin/config/about_controller.rb
+++ b/app/controllers/admin/config/about_controller.rb
@@ -12,6 +12,7 @@ class Admin::Config::AboutController < Admin::AdminController
       settings_map[:about_banner_image] = general_settings[:about_banner_image]
 
       settings_map[:extended_site_description] = general_settings[:extended_description]
+      settings_map[:short_site_description] = general_settings[:community_title]
       if settings_map[:extended_site_description].present?
         settings_map[:extended_site_description_cooked] = PrettyText.markdown(
           settings_map[:extended_site_description],
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index b71351d19ea..cbfd66a7213 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -5619,6 +5619,8 @@ en:
           community_name_placeholder: "Example Community"
           community_summary: "Community summary"
           community_description: "Community description"
+          community_title: "Community title"
+          community_title_help: "Short description, shown in the browser tab, for key pages such as categories and topic lists."
           banner_image: "Banner image"
           banner_image_help: |
             This will be used on your About page. Recommended size: 1100x300px. Accepted types: JPG, PNG, and SVG up to 10MB.
diff --git a/spec/system/admin_about_config_area_spec.rb b/spec/system/admin_about_config_area_spec.rb
index a488694a1f8..dcebb9040f1 100644
--- a/spec/system/admin_about_config_area_spec.rb
+++ b/spec/system/admin_about_config_area_spec.rb
@@ -14,6 +14,7 @@ describe "Admin About Config Area Page", type: :system do
       SiteSetting.site_description = "this is a description for my forums"
       SiteSetting.about_banner_image = image_upload
       SiteSetting.extended_site_description = "this is an extended description for my forums"
+      SiteSetting.short_site_description = "short description for browser tab"
 
       SiteSetting.community_owner = "kitty"
       SiteSetting.contact_email = "kitty@litterbox.com"
@@ -38,6 +39,9 @@ describe "Admin About Config Area Page", type: :system do
       expect(config_area.general_settings_section.community_description_editor.value).to eq(
         "this is an extended description for my forums",
       )
+      expect(config_area.general_settings_section.community_title_input.value).to eq(
+        "short description for browser tab",
+      )
       expect(config_area.general_settings_section.banner_image_uploader).to have_uploaded_image
 
       expect(config_area.contact_information_section.community_owner_input.value).to eq("kitty")
@@ -78,6 +82,9 @@ describe "Admin About Config Area Page", type: :system do
       config_area.general_settings_section.community_description_editor.fill_in(
         "here's an extended description for the **community**",
       )
+      config_area.general_settings_section.community_title_input.fill_in(
+        "here's a title for my site",
+      )
       config_area.general_settings_section.banner_image_uploader.select_image(image_file.path)
       expect(config_area.general_settings_section.banner_image_uploader).to have_uploaded_image
 
@@ -93,6 +100,7 @@ describe "Admin About Config Area Page", type: :system do
       expect(SiteSetting.extended_site_description_cooked).to eq(
         "<p>here’s an extended description for the <strong>community</strong></p>",
       )
+      expect(SiteSetting.short_site_description).to eq("here's a title for my site")
       expect(SiteSetting.about_banner_image.sha1).to eq(Upload.generate_digest(image_file))
     end
 
diff --git a/spec/system/page_objects/components/admin_about_config_area_general_settings_card.rb b/spec/system/page_objects/components/admin_about_config_area_general_settings_card.rb
index 6e8b70add32..08840640916 100644
--- a/spec/system/page_objects/components/admin_about_config_area_general_settings_card.rb
+++ b/spec/system/page_objects/components/admin_about_config_area_general_settings_card.rb
@@ -15,6 +15,10 @@ module PageObjects
         form.field("extendedDescription")
       end
 
+      def community_title_input
+        form.field("communityTitle")
+      end
+
       def banner_image_uploader
         PageObjects::Components::UppyImageUploader.new(card.find(".image-uploader"))
       end