From 5a8bbc3f87376cfe282fa5ec18672c3536a51087 Mon Sep 17 00:00:00 2001 From: Mark VanLandingham Date: Mon, 5 Jun 2023 09:39:31 -0500 Subject: [PATCH] FEATURE: Site setting to control search menu tip addition (#136) --- .../discourse/initializers/setup-docs.js | 23 +++++++++++-------- config/locales/server.en.yml | 1 + config/settings.yml | 3 +++ 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/assets/javascripts/discourse/initializers/setup-docs.js b/assets/javascripts/discourse/initializers/setup-docs.js index ae85743..7c848da 100644 --- a/assets/javascripts/discourse/initializers/setup-docs.js +++ b/assets/javascripts/discourse/initializers/setup-docs.js @@ -30,17 +30,20 @@ export default { } withPluginApi("0.8", (api) => initialize(api, container)); - withPluginApi("0.12.6", (api) => { - api.addSearchSuggestion("in:docs"); - const tip = { - label: "in:docs", - description: I18n.t("docs.search.tip_description"), - clickable: true, - searchTopics: true, - }; - api.addQuickSearchRandomTip(tip); - }); + if (siteSettings.docs_add_search_menu_tip) { + withPluginApi("0.12.6", (api) => { + api.addSearchSuggestion("in:docs"); + + const tip = { + label: "in:docs", + description: I18n.t("docs.search.tip_description"), + clickable: true, + searchTopics: true, + }; + api.addQuickSearchRandomTip(tip); + }); + } withPluginApi("1.2.0", (api) => { if (siteSettings.navigation_menu !== "legacy") { diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml index 760f168..5d00c9f 100644 --- a/config/locales/server.en.yml +++ b/config/locales/server.en.yml @@ -5,3 +5,4 @@ en: docs_tags: "A list of tags to include in docs" docs_add_solved_filter: "Adds a filter for solved topics -- requires Discourse Solved to be installed and enabled" docs_add_to_top_menu: "Adds a link to the top menu to navigate to the Docs view" + docs_add_search_menu_tip: "Adds the tip \"in:docs\" to the search menu random tips" diff --git a/config/settings.yml b/config/settings.yml index 286c5a0..881c0fa 100644 --- a/config/settings.yml +++ b/config/settings.yml @@ -16,3 +16,6 @@ plugins: docs_add_to_top_menu: default: false client: true + docs_add_search_menu_tip: + default: true + client: true