fix: update doc links (#3729)

Author: ElinorW

src/app/services/graph-constants.ts

@@ -34,3 +34,10 @@ export const CONSENT_TYPE_DOC_LINK = 'https://learn.microsoft.com/en-us/graph/ap
 export const CURRENT_THEME='CURRENT_THEME';
 export const EXP_URL='https://default.exp-tas.com/exptas76/9b835cbf-9742-40db-84a7-7a323a77f3eb-gedev/api/v1/tas'
 export const BANNER_IS_VISIBLE = 'bannerIsVisible';
+export const REPORTANISSUELINK = 'https://github.com/microsoftgraph/microsoft-graph-explorer-v4/issues/new/choose';
+export const GEDOCSLINK =
+  'https://learn.microsoft.com/graph/graph-explorer/graph-explorer-overview?view=graph-rest-1.0'
+export const GRAPHDOCSLINK =
+  'https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0'
+export const GITHUBLINK = 'https://github.com/microsoftgraph/microsoft-graph-explorer-v4#readme'
+export const TRACKINGPARAMS = '/?WT.mc_id=msgraph_inproduct_graphexhelp'

src/app/views/main-header/Help.tsx

@@ -11,18 +11,19 @@ import {
 } from '../../../telemetry/component-names'
 import { translateMessage } from '../../utils/translate-messages'
 import { useHeaderStyles } from './utils'
+import { REPORTANISSUELINK,
+  GEDOCSLINK,
+  TRACKINGPARAMS,
+  GRAPHDOCSLINK,
+  GITHUBLINK
+} from '../../services/graph-constants'
 
 const trackHelpButtonClickEvent = () => {
   telemetry.trackEvent(eventTypes.BUTTON_CLICK_EVENT, {
     ComponentName: componentNames.HELP_BUTTON
   });
 }
 
-const reportAnIssueLink = 'https://github.com/microsoftgraph/microsoft-graph-explorer-v4/issues/new/choose';
-const geDocsLink = 'https://learn.microsoft.com/graph/graph-explorer/graph-explorer-overview?view=graph-rest-1.0'
-const graphDocsLink = 'https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0'
-const ghLink = 'https://github.com/microsoftgraph/microsoft-graph-explorer-v4#readme'
-
 const trackLinkClick = (e: React.MouseEvent<HTMLAnchorElement>, componentName: string) => {
   telemetry.trackLinkClickEvent(e.currentTarget.href, componentName)
 }
@@ -32,42 +33,42 @@ const Help = ()=>{
 
   return (
     <Menu>
-      <Tooltip content={translateMessage('Help')} relationship="description">
+      <Tooltip content={translateMessage('Help')} relationship='description'>
         <MenuTrigger disableButtonEnhancement>
           <Button
             aria-label={translateMessage('Help')}
             onClick={trackHelpButtonClickEvent}
-            className={styles.iconButton} appearance="subtle" icon={<ChatHelp20Regular />} />
+            className={styles.iconButton} appearance='subtle' icon={<ChatHelp20Regular />} />
         </MenuTrigger>
       </Tooltip>
 
       <MenuPopover>
         <MenuList>
           <MenuItemLink
             as='a'
-            href={reportAnIssueLink} target="_blank"
+            href={REPORTANISSUELINK} target='_blank'
             onClick={(e: React.MouseEvent<HTMLAnchorElement>)=> trackLinkClick(e, REPORT_AN_ISSUE_LINK)}
             icon={<DocumentQuestionMark20Regular />}>{translateMessage('Report an Issue')}</MenuItemLink>
         </MenuList>
         <MenuDivider />
         <MenuList>
           <MenuItemLink
             as='a'
-            href={geDocsLink} target="_blank"
+            href={GEDOCSLINK + TRACKINGPARAMS} target='_blank'
             onClick={(e: React.MouseEvent<HTMLAnchorElement>)=> trackLinkClick(e, GE_DOCUMENTATION_LINK)}
             icon={<DocumentOnePage20Regular />}>{translateMessage('Get started with Graph Explorer')}</MenuItemLink>
         </MenuList>
         <MenuList>
           <MenuItemLink
             as='a'
-            href={graphDocsLink} target="_blank"
+            href={GRAPHDOCSLINK + TRACKINGPARAMS} target='_blank'
             onClick={(e: React.MouseEvent<HTMLAnchorElement>)=> trackLinkClick(e, GRAPH_DOCUMENTATION_LINK)}
             icon={<DocumentMultiple20Regular />}>{translateMessage('Graph Documentation')}</MenuItemLink>
         </MenuList>
         <MenuList>
           <MenuItemLink
             as='a'
-            href={ghLink} target="_blank"
+            href={GITHUBLINK} target='_blank'
             onClick={(e: React.MouseEvent<HTMLAnchorElement>)=> trackLinkClick(e, GITHUB_LINK)}
             icon={<Branch20Regular />}>GitHub</MenuItemLink>
         </MenuList>

src/app/views/query-runner/query-input/auto-complete/suffix/SuffixRenderer.tsx

@@ -45,8 +45,14 @@ const SuffixRenderer = () => {
       source: queries
     }).getDocumentationLink();
 
-    return sampleDocumentationUrl || resourceDocumentationUrl || null;
-  };
+    const documentationUrl = sampleDocumentationUrl || resourceDocumentationUrl;
+    if (documentationUrl) {
+      const hasQuery = documentationUrl.includes('?');
+      const param = 'WT.mc_id=msgraph_inproduct_graphexhelp';
+      return `${documentationUrl}${hasQuery ? '&' : '?'}${param}`;
+    }
+    return null;
+  }
 
   const documentationLink = getDocumentationLink();
   const documentationLinkAvailable = !!documentationLink;

src/app/views/sidebar/sample-queries/SampleQueries.tsx

@@ -33,7 +33,7 @@ import React, { useEffect, useRef, useState } from 'react';
 import { useAppDispatch, useAppSelector } from '../../../../store';
 import { componentNames, telemetry } from '../../../../telemetry';
 import { IQuery, ISampleQuery } from '../../../../types/query-runner';
-import { GRAPH_URL } from '../../../services/graph-constants';
+import { GRAPH_URL, GRAPHDOCSLINK, TRACKINGPARAMS } from '../../../services/graph-constants';
 import { setQueryResponseStatus } from '../../../services/slices/query-status.slice';
 import { setSampleQuery } from '../../../services/slices/sample-query.slice';
 import { fetchSamples } from '../../../services/slices/samples.slice';
@@ -116,7 +116,7 @@ export const SampleQueries = () => {
 const LoadingSamples = ()=> {
   return (
     <Spinner
-      size="large"
+      size='large'
       label={`${translateMessage('loading samples')} ...`}
       labelPosition='below'
     />
@@ -166,7 +166,7 @@ const SeeMoreQueriesMessageBar = () => {
               componentNames.MICROSOFT_GRAPH_API_REFERENCE_DOCS_LINK
             )
           }
-          href='https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0'
+          href={GRAPHDOCSLINK + TRACKINGPARAMS}
           inline={true}
         >
           {translateMessage('Microsoft Graph API Reference docs')}

src/messages/GE.json

@@ -515,7 +515,7 @@
   "Banner notification 1 header": "New to Graph Explorer?",
   "Banner notification 1 content": "Graph Explorer is a developer tool that let's you learn about Microsoft Graph APIs. Use Graph Explorer to try the APIs on the default sample tenant to explore capabilities.",
   "Banner notification 1 link text": "Follow a step-by-step tutorial",
-  "Banner notification 1 link": "https://learn.microsoft.com/graph/graph-explorer/graph-explorer-overview?view=graph-rest-1.0",
+  "Banner notification 1 link": "https://learn.microsoft.com/graph/graph-explorer/graph-explorer-overview?view=graph-rest-1.0/?WT.mc_id=msgraph_inproduct_graphex",
   "Dismiss banner": "Dismiss banner",
   "list of permissions": "The following is the list of least-privileged permissions required to call the operations in your API Collection. For more information, see ",
   "Preview permissions": "Preview permissions",