chore: doclink imported from common microservice

shivani170 · shivani170 · commit 8ed80968470c · 2025-05-14T16:44:27.000+05:30
diff --git a/src/Pages/App/CreateAppModal/Sidebar.tsx b/src/Pages/App/CreateAppModal/Sidebar.tsx
@@ -14,10 +14,9 @@
  * limitations under the License.
  */
 
-import { ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
+import { getDocumentationUrl, ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
 
 import { DOCUMENTATION } from '@Config/constants'
-import { getDocumentationUrl } from '@Config/DocLink'
 
 import { CreationMethodType, SidebarProps } from './types'
 
diff --git a/src/Pages/Applications/DevtronApps/Details/AppConfigurations/AppConfig.utils.ts b/src/Pages/Applications/DevtronApps/Details/AppConfigurations/AppConfig.utils.ts
@@ -20,12 +20,12 @@ import {
     AppConfigProps,
     BASE_CONFIGURATION_ENV_ID,
     ConfigResourceType,
+    getDocumentationUrl,
     ResourceKindType,
     stringComparatorBySortOrder,
     URLS as CommonURLS,
 } from '@devtron-labs/devtron-fe-common-lib'
 
-import { getDocumentationUrl } from '@Config/DocLink'
 import { APP_COMPOSE_STAGE, DOCUMENTATION, getAppComposeURL, URLS } from '@Config/index'
 
 import { AppConfigStatusItemType, EnvConfigDTO } from '../../service.types'
diff --git a/src/Pages/Applications/DevtronApps/Details/AppConfigurations/Navigation/EnvironmentOverrideRouter.tsx b/src/Pages/Applications/DevtronApps/Details/AppConfigurations/Navigation/EnvironmentOverrideRouter.tsx
@@ -20,6 +20,7 @@ import { Link, NavLink, useLocation, useParams, useRouteMatch } from 'react-rout
 import {
     ConfirmationDialog,
     DeleteConfirmationModal,
+    DocLink,
     EnvResourceType,
     getEnvironmentListMinPublic,
     InfoBlock,
@@ -49,14 +50,7 @@ const EnvOverridesHelpNote = () => (
     <div className="fs-12 fw-4 lh-18">
         Environment overrides allow you to manage environment specific configurations after you’ve created deployment
         pipelines. &nbsp;
-        <a
-            className="dc__link"
-            href={DOCUMENTATION.APP_CREATE_ENVIRONMENT_OVERRIDE}
-            rel="noreferrer noopener"
-            target="_blank"
-        >
-            Learn more
-        </a>
+        <DocLink docLink={DOCUMENTATION.APP_CREATE_ENVIRONMENT_OVERRIDE} dataTestId="env-overrides-learn-more" />
     </div>
 )
 
diff --git a/src/Pages/Shared/ConfigMapSecret/helpers.tsx b/src/Pages/Shared/ConfigMapSecret/helpers.tsx
@@ -19,6 +19,7 @@ import { Link } from 'react-router-dom'
 import {
     CMSecretComponentType,
     CMSecretExternalType,
+    DocLink,
     Icon,
     InfoBlock,
     InfoColourBar,
@@ -81,14 +82,11 @@ export const renderChartVersionBelow3090NotSupportedText = () => (
     <span className="fs-12 fw-4">
         <span className="cr-5">Supported for Chart Versions 3.10 and above.</span>&nbsp;
         <span className="cn-7">Learn more about</span>&nbsp;
-        <a
-            className="dc__link"
-            href={DOCUMENTATION.APP_ROLLOUT_DEPLOYMENT_TEMPLATE}
-            rel="noreferrer noopener"
-            target="_blank"
-        >
-            Deployment Template &gt; Chart Version
-        </a>
+        <DocLink
+            docLink={DOCUMENTATION.APP_ROLLOUT_DEPLOYMENT_TEMPLATE}
+            docLinkText="Deployment Template &gt; Chart Version"
+            dataTestId="chart-version-learn-more"
+        />
     </span>
 )
 
diff --git a/src/Pages/Shared/EnvironmentOverride/EnvironmentOverrides.types.ts b/src/Pages/Shared/EnvironmentOverride/EnvironmentOverrides.types.ts
@@ -16,9 +16,8 @@
 
 import React from 'react'
 
-import { AppConfigProps } from '@devtron-labs/devtron-fe-common-lib'
+import { AppConfigProps, getDocumentationUrl } from '@devtron-labs/devtron-fe-common-lib'
 
-import { getDocumentationUrl } from '@Config/DocLink'
 import {
     AppConfigState,
     EnvConfigurationState,
diff --git a/src/components/ApplicationGroup/Details/TriggerView/BulkCITrigger.tsx b/src/components/ApplicationGroup/Details/TriggerView/BulkCITrigger.tsx
@@ -42,6 +42,8 @@ import {
     uploadCIPipelineFile,
     UploadFileProps,
     savePipeline,
+    DOCUMENTATION,
+    getDocumentationUrl
 } from '@devtron-labs/devtron-fe-common-lib'
 import Tippy from '@tippyjs/react'
 import { getCIPipelineURL, getParsedBranchValuesForPlugin, importComponentFromFELibrary } from '../../../common'
@@ -56,7 +58,7 @@ import externalCiImg from '../../../../assets/img/external-ci.webp'
 import linkedCDBuildCIImg from '../../../../assets/img/linked-cd-bulk-ci.webp'
 import linkedCiImg from '../../../../assets/img/linked-ci.webp'
 import { getModuleConfigured } from '../../../app/details/appDetails/appDetails.service'
-import { DOCUMENTATION, SOURCE_NOT_CONFIGURED, URLS, ViewType } from '../../../../config'
+import { SOURCE_NOT_CONFIGURED, URLS, ViewType } from '../../../../config'
 import MaterialSource from '../../../app/details/triggerView/MaterialSource'
 import { TriggerViewContext } from '../../../app/details/triggerView/config'
 import { getCIMaterialList } from '../../../app/service'
@@ -782,7 +784,7 @@ const BulkCITrigger = ({
                                 <span>{IGNORE_CACHE_INFO.BlobStorageNotConfigured.infoText}</span>
                                 <a
                                     className="fs-12 fw-6 cb-5 dc__no-decor ml-4"
-                                    href={DOCUMENTATION.BLOB_STORAGE}
+                                    href={getDocumentationUrl(DOCUMENTATION.BLOB_STORAGE)}
                                     target="_blank"
                                     rel="noreferrer"
                                 >
diff --git a/src/components/CIPipelineN/Sidebar.tsx b/src/components/CIPipelineN/Sidebar.tsx
@@ -24,6 +24,7 @@ import {
     ResourceKindType,
     WORKFLOW_CACHE_CONFIG_ENUM,
     TriggerType,
+    getDocumentationUrl
 } from '@devtron-labs/devtron-fe-common-lib'
 import Tippy from '@tippyjs/react'
 import { BuildStageVariable, DOCUMENTATION } from '../../config'
@@ -37,7 +38,6 @@ import { ReactComponent as Add } from '../../assets/icons/ic-add.svg'
 import { ReactComponent as Remove } from '../../assets/icons/ic-close.svg'
 import { GeneratedHelmPush } from '../cdPipeline/cdPipeline.types'
 import { EnvironmentList } from './EnvironmentList'
-import { getDocumentationUrl } from '@Config/DocLink'
 
 const MandatoryPluginWarning = importComponentFromFELibrary('MandatoryPluginWarning')
 const CacheConfiguration = importComponentFromFELibrary('CacheConfiguration', null, 'function')
diff --git a/src/components/app/details/appDetails/AppDetails.tsx b/src/components/app/details/appDetails/AppDetails.tsx
@@ -24,6 +24,7 @@ import {
     ArtifactInfoModal,
     Button,
     DeploymentAppTypes,
+    DocLink,
     GenericEmptyState,
     getAppsInfoForEnv,
     getIsRequestAborted,
@@ -44,7 +45,6 @@ import { ReactComponent as ForwardArrow } from '@Icons/ic-arrow-forward.svg'
 import { ReactComponent as Trash } from '@Icons/ic-delete-dots.svg'
 import AppNotConfiguredIcon from '@Images/app-not-configured.png'
 import noGroups from '@Images/ic-feature-deploymentgroups@3x.png'
-import { DocLink } from '@Config/DocLink'
 
 import {
     DEFAULT_STATUS,
diff --git a/src/components/app/details/triggerView/TriggerView.tsx b/src/components/app/details/triggerView/TriggerView.tsx
@@ -35,9 +35,10 @@ import {
     BlockedStateData,
     getEnvironmentListMinPublic,
     CIPipelineNodeType,
+    DocLink,
 } from '@devtron-labs/devtron-fe-common-lib'
 import ReactGA from 'react-ga4'
-import { withRouter, NavLink, Route, Switch } from 'react-router-dom'
+import { withRouter, Route, Switch } from 'react-router-dom'
 import {
     getCIMaterialList,
     triggerCINode,
@@ -91,7 +92,6 @@ import { CIMaterialModal } from './CIMaterialModal'
 import { WebhookReceivedPayloadModal } from './WebhookReceivedPayloadModal'
 import { getExternalCIConfig } from '@Components/ciPipeline/Webhook/webhook.service'
 import { shouldRenderWebhookAddImageModal } from './TriggerView.utils'
-import { DocLink } from '@Config/DocLink'
 
 const ApprovalMaterialModal = importComponentFromFELibrary('ApprovalMaterialModal')
 const getCIBlockState: (...props) => Promise<BlockedStateData> = importComponentFromFELibrary(
diff --git a/src/components/app/details/triggerView/ciMaterial.tsx b/src/components/app/details/triggerView/ciMaterial.tsx
@@ -32,6 +32,8 @@ import {
     Tooltip,
     DEFAULT_ROUTE_PROMPT_MESSAGE,
     savePipeline,
+    DOCUMENTATION,
+    getDocumentationUrl
 } from '@devtron-labs/devtron-fe-common-lib'
 import { CIMaterialProps, CIMaterialState, RegexValueType } from './types'
 import { ReactComponent as ICInfoOutline } from '@Icons/ic-info-outline-grey.svg'
@@ -40,7 +42,7 @@ import { ReactComponent as Info } from '../../../../assets/icons/info-filled.svg
 import { ReactComponent as Storage } from '../../../../assets/icons/ic-storage.svg'
 import { ReactComponent as OpenInNew } from '../../../../assets/icons/ic-open-in-new.svg'
 import { getCIPipelineURL, importComponentFromFELibrary } from '../../../common'
-import { DOCUMENTATION, SOURCE_NOT_CONFIGURED } from '../../../../config'
+import { SOURCE_NOT_CONFIGURED } from '../../../../config'
 import { getModuleConfigured } from '../appDetails/appDetails.service'
 import { TriggerViewContext } from './config'
 import { IGNORE_CACHE_INFO } from './Constants'
@@ -137,7 +139,7 @@ class CIMaterial extends Component<CIMaterialProps, CIMaterialState> {
                             <span>{IGNORE_CACHE_INFO.BlobStorageNotConfigured.infoText}</span>
                             <a
                                 className="fs-12 fw-6 cb-5 dc__no-decor ml-4"
-                                href={DOCUMENTATION.BLOB_STORAGE}
+                                href={getDocumentationUrl(DOCUMENTATION.BLOB_STORAGE)}
                                 target="_blank"
                                 rel="noreferrer"
                             >
diff --git a/src/components/bulkEdits/BulkEdits.tsx b/src/components/bulkEdits/BulkEdits.tsx
@@ -32,6 +32,7 @@ import {
     ButtonVariantType,
     ButtonStyleType,
     MODES,
+    getDocumentationUrl
 } from '@devtron-labs/devtron-fe-common-lib'
 import { DOCUMENTATION, SERVER_MODE, ViewType } from '../../config'
 import { BulkEditsProps, BulkEditsState } from './bulkEdits.type'
@@ -525,7 +526,7 @@ export default class BulkEdits extends Component<BulkEditsProps, BulkEditsState>
                     tippyProps={{
                         isTippyCustomized: true,
                         tippyMessage: 'Run scripts to bulk edit configurations for multiple devtron components.',
-                        tippyRedirectLink: DOCUMENTATION.BULK_UPDATE,
+                        tippyRedirectLink: getDocumentationUrl(DOCUMENTATION.BULK_UPDATE),
                     }}
                 />
                 {this.renderBulkEditBody()}
diff --git a/src/components/ciConfig/CIBuildpackBuildOptions.tsx b/src/components/ciConfig/CIBuildpackBuildOptions.tsx
@@ -25,6 +25,7 @@ import {
     SelectPicker,
     stopPropagation,
     OptionType,
+    getDocumentationUrl,
 } from '@devtron-labs/devtron-fe-common-lib'
 import {
     DropdownIndicator,
@@ -158,7 +159,7 @@ const BuilderTippy = () => {
             infoText={CI_BUILDPACK_OPTION_TEXTS.BuilderTippyContent.infoText}
             additionalContent={additionalBuilderTippyContent()}
             documentationLinkText={CI_BUILDPACK_OPTION_TEXTS.BuilderTippyContent.documentationLinkText}
-            documentationLink={DOCUMENTATION.APP_CI_CONFIG_BUILD_WITHOUT_DOCKER}
+            documentationLink={getDocumentationUrl(DOCUMENTATION.APP_CI_CONFIG_BUILD_WITHOUT_DOCKER)}
             iconClassName="icon-dim-16 fcn-6 ml-4"
         />
     )
diff --git a/src/components/ciConfig/CIConfigForm.tsx b/src/components/ciConfig/CIConfigForm.tsx
@@ -25,6 +25,7 @@ import {
     ConfirmationModalVariantType,
     Button,
     OptionType,
+    getDocumentationUrl,
 } from '@devtron-labs/devtron-fe-common-lib'
 import { DOCUMENTATION } from '../../config'
 import { CIPipelineBuildType, DockerConfigOverrideKeys } from '../ciPipeline/types'
@@ -50,7 +51,6 @@ import {
     initCurrentCIBuildConfig,
     processBuildArgs,
 } from './CIConfig.utils'
-import { getDocumentationUrl } from '@Config/DocLink'
 
 export default function CIConfigForm({
     parentReloading,
diff --git a/src/components/externalLinks/ExternalLinks.component.tsx b/src/components/externalLinks/ExternalLinks.component.tsx
@@ -52,6 +52,7 @@ import {
     ButtonStyleType,
     ImageWithFallback,
     InfoBlock,
+    DocLink,
 } from '@devtron-labs/devtron-fe-common-lib'
 import './externalLinks.component.scss'
 import { UserRoleType } from '../../Pages/GlobalConfigurations/Authorization/constants'
@@ -60,7 +61,6 @@ import { ReactComponent as ICClose } from '@Icons/ic-close.svg'
 import ICWebpage from '@Icons/tools/ic-link-webpage.png'
 import { AddLinkButton } from './AddLinkButton'
 import { Link } from 'react-router-dom'
-import { DocLink, getDocumentationUrl } from '@Config/DocLink'
 
 export const ExternalLinksLearnMore = (): JSX.Element => {
     return (
diff --git a/src/components/externalLinks/ExternalLinks.tsx b/src/components/externalLinks/ExternalLinks.tsx
@@ -22,6 +22,7 @@ import {
     ErrorScreenManager,
     FilterChips,
     getClusterListMin,
+    getDocumentationUrl,
     InfoIconTippy,
     Progressing,
     SearchBar,
@@ -32,7 +33,6 @@ import {
 } from '@devtron-labs/devtron-fe-common-lib'
 
 import { DeleteComponentsName } from '@Config/constantMessaging'
-import { getDocumentationUrl } from '@Config/DocLink'
 
 import { DOCUMENTATION, SERVER_MODE } from '../../config'
 import { sortOptionsByLabel, sortOptionsByValue } from '../common'
diff --git a/src/components/externalLinks/ExternalLinksCRUD/AddExternalLink.tsx b/src/components/externalLinks/ExternalLinksCRUD/AddExternalLink.tsx
@@ -28,6 +28,7 @@ import {
     ComponentSizeType,
     getHandleOpenURL,
     OptionType,
+    getDocumentationUrl
 } from '@devtron-labs/devtron-fe-common-lib'
 import { DEVTRON_IFRAME_PRIMARY, DOCUMENTATION } from '@Config/constants'
 import { createGroupedItemsByKey } from '../../common'
@@ -48,7 +49,6 @@ import { ReactComponent as Close } from '../../../assets/icons/ic-close.svg'
 import { ReactComponent as Help } from '../../../assets/icons/ic-help.svg'
 import { ReactComponent as ICOpenBook } from '@Icons/ic-book-open.svg'
 import './AddExternalLink.scss'
-import { getDocumentationUrl } from '@Config/DocLink'
 
 export default function AddExternalLink({
     appId,
diff --git a/src/components/login/LoginForm.tsx b/src/components/login/LoginForm.tsx
@@ -23,6 +23,7 @@ import {
     ButtonVariantType,
     ComponentSizeType,
     CustomInput,
+    DocLink,
     Icon,
     PasswordField,
     ServerErrors,
@@ -141,15 +142,12 @@ export const LoginForm = ({ loginList }: LoginFormType) => {
 
                     <div className="flex left dc__gap-4">
                         <Icon name="ic-help-outline" color="B500" size={12} />
-
-                        <a
-                            className="anchor fs-11 cb-5"
-                            rel="noreferrer noopener"
-                            target="_blank"
-                            href={DOCUMENTATION.ADMIN_PASSWORD}
-                        >
-                            What is my admin password?
-                        </a>
+                        <DocLink
+                            docLink={DOCUMENTATION.ADMIN_PASSWORD}
+                            docLinkText="What is my admin password?"
+                            dataTestId="learn-more-about-admin-password"
+                            className="fs-11"
+                        />
                     </div>
                 </div>
             </div>
diff --git a/src/components/material/MaterialList.tsx b/src/components/material/MaterialList.tsx
@@ -21,6 +21,7 @@ import {
     ErrorScreenManager,
     sortCallback,
     AppListConstants,
+    DocLink,
 } from '@devtron-labs/devtron-fe-common-lib'
 import { getGitProviderListAuth, getSourceConfig } from '../../services/service'
 import { AppConfigStatus, ViewType, DOCUMENTATION, DEVTRON_NODE_DEPLOY_VIDEO } from '../../config'
@@ -31,7 +32,6 @@ import { ReactComponent as GitHub } from '@Icons/ic-sample-app.svg'
 import { ReactComponent as PlayMedia } from '@Icons/ic-play-outline.svg'
 import { ReactComponent as Folder } from '@Icons/ic-folder-filled.svg'
 import './material.scss'
-import { DocLink } from '@Config/DocLink'
 
 class MaterialList extends Component<MaterialListProps, MaterialListState> {
     constructor(props) {
@@ -164,7 +164,6 @@ class MaterialList extends Component<MaterialListProps, MaterialListState> {
                 </h2>
                 <p className="form__subtitle form__subtitle--artifacts">
                     Manage source code repositories for this {this.props.isJobView ? 'job' : 'application'}.&nbsp;
-
                     <DocLink
                         docLink={this.props.isJobView ? DOCUMENTATION.JOB_SOURCE_CODE : DOCUMENTATION.GLOBAL_CONFIG_GIT}
                         dataTestId="learn-more-about-git-repositories-link"
@@ -253,7 +252,8 @@ class MaterialList extends Component<MaterialListProps, MaterialListState> {
                             isTemplateView={this.props.isTemplateView}
                             isCreateAppView={this.props.isCreateAppView}
                             handleSingleGitMaterialUpdate={this.handleSingleGitMaterialUpdate(mat.id)}
-                        />                    )
+                        />
+                    )
                 })}
             </div>
         )
diff --git a/src/components/v2/appDetails/k8Resource/nodeDetail/EphemeralContainerDrawer.tsx b/src/components/v2/appDetails/k8Resource/nodeDetail/EphemeralContainerDrawer.tsx
@@ -29,6 +29,7 @@ import {
     SelectPicker,
     ComponentSizeType,
     MODES,
+    getDocumentationUrl,
 } from '@devtron-labs/devtron-fe-common-lib'
 import { useEffect, useState } from 'react'
 import yamlJsParser from 'yaml'
@@ -185,7 +186,7 @@ const EphemeralContainerDrawer = ({
                         heading={EPHEMERAL_CONTAINER.TITLE}
                         infoText={EPHEMERAL_CONTAINER.SUBTITLE}
                         iconClassName="icon-dim-20 fcn-6 ml-8"
-                        documentationLink={DOCUMENTATION.APP_EPHEMERAL_CONTAINER}
+                        documentationLink={getDocumentationUrl(DOCUMENTATION.APP_EPHEMERAL_CONTAINER)}
                         documentationLinkText="View Documentation"
                     />
                 </h2>
diff --git a/src/components/workflowEditor/workflowEditor.tsx b/src/components/workflowEditor/workflowEditor.tsx
@@ -37,6 +37,8 @@ import {
     ConfirmationModalVariantType,
     deleteWorkflow,
     InfoBlock,
+    getDocumentationUrl,
+    DocLink,
 } from '@devtron-labs/devtron-fe-common-lib'
 import Tippy from '@tippyjs/react'
 import { PipelineContext, WorkflowEditProps, WorkflowEditState } from './types'
@@ -67,7 +69,6 @@ import EmptyWorkflow from './EmptyWorkflow'
 import { WorkflowCreate } from '../app/details/triggerView/config'
 import { LinkedCIDetail } from '../../Pages/Shared/LinkedCIDetailsModal'
 import { WORKFLOW_EDITOR_HEADER_TIPPY } from './constants'
-import { DocLink, getDocumentationUrl } from '@Config/DocLink'
 
 export const pipelineContext = createContext<PipelineContext>(null)
 const SyncEnvironment = importComponentFromFELibrary('SyncEnvironment')
diff --git a/src/config/DocLink/DocLink.tsx b/src/config/DocLink/DocLink.tsx
diff --git a/src/config/DocLink/index.ts b/src/config/DocLink/index.ts
diff --git a/src/config/constants.ts b/src/config/constants.ts
