[Fix] Added documentation link for the dev tools' help menu (#5166)

* Add documentation link to dev tool's help menu Signed-off-by: Willie Hung <willie880201044@gmail.com> * Add CHANGELOG Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Edit CHANGELOG message Signed-off-by: Willie Hung <willie880201044@gmail.com> * Changed new file copyright license Signed-off-by: Willie Hung <willie880201044@gmail.com> * Update new snapshots Signed-off-by: Willie Hung <willie880201044@gmail.com> --------- Signed-off-by: Willie Hung <willie880201044@gmail.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com>
opensearch-project · Oct 14, 2023 · 60f4c8f · 60f4c8f
1 parent 7a964b6
commit 60f4c8f
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -68,6 +68,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [BUG][Data Explorer][Discover] Allow filter and query persist when refresh page or paste url to a new tab ([#5206](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5206))
 - [Data Explorer] Remove the `X` icon in data source selection field ([#5238](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5238))
 - [BUG][Fuctional Test] Make setDefaultAbsoluteRange more robust and update doc views tests ([#5242](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5242))
+- [BUG][Dev Tool] Add dev tool documentation link to dev tool's help menu [#5166](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/5166)
 
 ### 🚞 Infrastructure
 

diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
@@ -388,6 +388,8 @@ export class DocLinksService {
           ganttCharts: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}gantt`,
           // https://opensearch.org/docs/latest/dashboards/reporting/
           reporting: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}reporting`,
+          // https://opensearch.org/docs/latest/dashboards/dev-tools/index-dev/
+          devTools: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dev-tools/index-dev/`,
           notebooks: {
             // https://opensearch.org/docs/latest/dashboards/notebooks/
             base: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks`,

diff --git a/...ic/application/components/dashboard_listing/__snapshots__/dashboard_listing.test.tsx.snap b/...ic/application/components/dashboard_listing/__snapshots__/dashboard_listing.test.tsx.snap
diff --git a/...ic/application/components/dashboard_top_nav/__snapshots__/dashboard_top_nav.test.tsx.snap b/...ic/application/components/dashboard_top_nav/__snapshots__/dashboard_top_nav.test.tsx.snap
diff --git a/src/plugins/dev_tools/public/application.tsx b/src/plugins/dev_tools/public/application.tsx
@@ -57,6 +57,7 @@ import { useEffectOnce } from 'react-use';
 import { getDataSources } from '../../data_source_management/public/components/utils';
 import { DevToolApp } from './dev_tool';
 import { DevToolsSetupDependencies } from './plugin';
+import { addHelpMenuToAppChrome } from './utils/util';
 
 interface DevToolsWrapperProps {
   devTools: readonly DevToolApp[];
@@ -254,7 +255,7 @@ function setBreadcrumbs(chrome: ChromeStart) {
 }
 
 export function renderApp(
-  { application, chrome, savedObjects, notifications }: CoreStart,
+  { application, chrome, docLinks, savedObjects, notifications }: CoreStart,
   element: HTMLElement,
   history: ScopedHistory,
   devTools: readonly DevToolApp[],
@@ -265,6 +266,7 @@ export function renderApp(
     return () => {};
   }
 
+  addHelpMenuToAppChrome(chrome, docLinks);
   setBadge(application, chrome);
   setBreadcrumbs(chrome);
   setTitle(chrome);

diff --git a/src/plugins/dev_tools/public/utils/util.ts b/src/plugins/dev_tools/public/utils/util.ts
@@ -0,0 +1,24 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { i18n } from '@osd/i18n';
+import { CoreStart } from 'opensearch-dashboards/public';
+
+export function addHelpMenuToAppChrome(
+  chrome: CoreStart['chrome'],
+  docLinks: CoreStart['docLinks']
+) {
+  chrome.setHelpExtension({
+    appName: i18n.translate('devTools.helpMenu.appName', {
+      defaultMessage: 'Dev Tools',
+    }),
+    links: [
+      {
+        linkType: 'documentation',
+        href: `${docLinks.links.opensearchDashboards.devTools}`,
+      },
+    ],
+  });
+}