chore: modification in the naming of the Doclink

Author: shivani170

src/Common/DocLink/DocLink.tsx

@@ -4,11 +4,18 @@ import { ComponentSizeType } from '@Shared/constants'
 import { DocLinkProps } from './types'
 import { getDocumentationUrl } from './utils'
 
-export const DocLink = ({ doc, text = 'Learn more', dataTestId, showExternalIcon, onClick }: DocLinkProps) => (
+export const DocLink = ({
+    docLinkKey,
+    text = 'Learn more',
+    dataTestId,
+    showExternalIcon,
+    onClick,
+    hideVersion = false,
+}: DocLinkProps) => (
     <Button
         component={ButtonComponentType.anchor}
         anchorProps={{
-            href: getDocumentationUrl(doc),
+            href: getDocumentationUrl({ docLinkKey, hideVersion }),
         }}
         onClick={onClick}
         dataTestId={dataTestId}

src/Common/DocLink/types.ts

@@ -3,7 +3,10 @@ import { ButtonComponentType, ButtonProps } from '@Shared/Components'
 import { DOCUMENTATION } from './constants'
 
 export interface DocLinkProps extends Pick<ButtonProps<ButtonComponentType.anchor>, 'onClick' | 'dataTestId'> {
-    doc: keyof typeof DOCUMENTATION
+    docLinkKey: keyof typeof DOCUMENTATION
     text?: string
     showExternalIcon?: boolean
+    hideVersion?: boolean
 }
+
+export interface DocumentationUrlParamsType extends Pick<DocLinkProps, 'docLinkKey' | 'hideVersion'> {}

src/Common/DocLink/utils.ts

@@ -1,9 +1,14 @@
 import { DOCUMENTATION_HOME_PAGE, DOCUMENTATION_VERSION } from '@Common/Constants'
 
 import { DOCUMENTATION } from './constants'
+import { DocumentationUrlParamsType } from './types'
 
 export const appendUtmToUrl = (docLinkKey: keyof typeof DOCUMENTATION) =>
     `${DOCUMENTATION[docLinkKey]}?utm_source=product`
 
-export const getDocumentationUrl = (docLinkKey: keyof typeof DOCUMENTATION) =>
-    `${DOCUMENTATION_HOME_PAGE}${DOCUMENTATION_VERSION}/${appendUtmToUrl(docLinkKey)}`
+export const getDocumentationUrl = ({ docLinkKey, hideVersion }: DocumentationUrlParamsType) => {
+    if (hideVersion) {
+        return DOCUMENTATION[docLinkKey]
+    }
+    return `${DOCUMENTATION_HOME_PAGE}${DOCUMENTATION_VERSION}/${appendUtmToUrl(docLinkKey)}`
+}

src/Common/TippyCustomized.tsx

@@ -158,7 +158,7 @@ export const TippyCustomized = (props: TippyCustomizedProps) => {
                 {documentationLink && (
                     <div className="px-12 pb-12 flexbox">
                         <DocLink
-                            doc={'APP_CREATE'}
+                            docLinkKey={'APP_CREATE'}
                             text={documentationLinkText}
                             dataTestId="learn-more-about-creating-job-link"
                             showExternalIcon

src/Shared/Components/CICDHistory/Artifacts.tsx

@@ -269,7 +269,7 @@ const Artifacts = ({
                             {EMPTY_STATE_STATUS.ARTIFACTS_EMPTY_STATE_TEXTS.StoreFiles}
                         </span>
                         <DocLink
-                            doc="BLOB_STORAGE"
+                            docLinkKey="BLOB_STORAGE"
                             text={EMPTY_STATE_STATUS.ARTIFACTS_EMPTY_STATE_TEXTS.ConfigureBlobStorage}
                             dataTestId="configure-blob-storage"
                         />

src/Shared/Components/CICDHistory/LogsRenderer.tsx

@@ -83,7 +83,7 @@ const renderBlobNotConfigured = (): JSX.Element => (
             <HelpIcon className="icon-dim-20 fcv-5" />
             <span className="fs-13 fw-4 mr-8 ml-8 text__white">Want to store logs to view later?</span>
 
-            <DocLink doc="BLOB_STORAGE" text="Configure blob storage" dataTestId="configure-blob-storage" />
+            <DocLink docLinkKey="BLOB_STORAGE" text="Configure blob storage" dataTestId="configure-blob-storage" />
             <OpenInNew className="icon-dim-20 ml-8" />
         </div>
     </>