fix: Remove invalid children prop from DocLink component

Author: shivani170

src/Pages/App/CreateAppModal/Sidebar.tsx

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { DOCUMENTATION, getDocumentationUrl, ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
+import { getDocumentationUrl, ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
 
 import { CreationMethodType, SidebarProps } from './types'
 
@@ -55,7 +55,7 @@ const Sidebar = ({
                     <div className="divider__secondary--horizontal" />
                     <ModalSidebarPanel
                         heading={null}
-                        documentationLink={getDocumentationUrl(DOCUMENTATION.APP_CREATE)}
+                        documentationLink={getDocumentationUrl({ docLinkKey: 'APP_CREATE' })}
                         rootClassName="w-100 dc__no-background-imp"
                     >
                         <div className="flexbox-col dc__gap-24">

src/Pages/Applications/DevtronApps/Details/AppConfigurations/AppConfig.utils.ts

@@ -20,7 +20,6 @@ import {
     AppConfigProps,
     BASE_CONFIGURATION_ENV_ID,
     ConfigResourceType,
-    DOCUMENTATION,
     getDocumentationUrl,
     ResourceKindType,
     stringComparatorBySortOrder,
@@ -139,7 +138,7 @@ export const getNavItems = ({
                         href: `/job/${appId}/edit/materials`,
                         stage: STAGE_NAME.GIT_MATERIAL,
                         isLocked: !_isUnlocked.material,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.JOB_SOURCE_CODE),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'JOB_SOURCE_CODE' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         required: true,
@@ -149,7 +148,7 @@ export const getNavItems = ({
                         href: `/job/${appId}/edit/workflow`,
                         stage: STAGE_NAME.WORKFLOW,
                         isLocked: !_isUnlocked.workflowEditor,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.JOB_WORKFLOW_EDITOR),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'JOB_WORKFLOW_EDITOR' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         required: true,
@@ -167,7 +166,7 @@ export const getNavItems = ({
                         href: getAppComposeURL(appId, APP_COMPOSE_STAGE.CONFIG_MAPS, true, isTemplateView),
                         stage: STAGE_NAME.CONFIGMAP,
                         isLocked: !_isUnlocked.configmap,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_CONFIG_MAP),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_CONFIG_MAP' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         isProtectionAllowed: true,
@@ -179,7 +178,7 @@ export const getNavItems = ({
                         href: getAppComposeURL(appId, APP_COMPOSE_STAGE.SECRETS, true, isTemplateView),
                         stage: STAGE_NAME.SECRETS,
                         isLocked: !_isUnlocked.secret,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_SECRET),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_SECRET' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         isProtectionAllowed: true,
@@ -205,7 +204,7 @@ export const getNavItems = ({
                         href: `${basePath}/edit/materials`,
                         stage: STAGE_NAME.GIT_MATERIAL,
                         isLocked: !_isUnlocked.material,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_MATERIAL),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_MATERIAL' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         required: true,
@@ -215,7 +214,7 @@ export const getNavItems = ({
                         href: `${basePath}/edit/docker-build-config`,
                         stage: STAGE_NAME.CI_CONFIG,
                         isLocked: !_isUnlocked.dockerBuildConfig,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_CI_CONFIG),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_CI_CONFIG' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         required: true,
@@ -234,7 +233,7 @@ export const getNavItems = ({
                         href: getAppComposeURL(appId, APP_COMPOSE_STAGE.DEPLOYMENT_TEMPLATE, null, isTemplateView),
                         stage: STAGE_NAME.DEPLOYMENT_TEMPLATE,
                         isLocked: !_isUnlocked.deploymentTemplate,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_DEPLOYMENT_TEMPLATE),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_DEPLOYMENT_TEMPLATE' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         isProtectionAllowed: true,
@@ -266,7 +265,7 @@ export const getNavItems = ({
                         href: getAppComposeURL(appId, APP_COMPOSE_STAGE.CONFIG_MAPS, null, isTemplateView),
                         stage: STAGE_NAME.CONFIGMAP,
                         isLocked: !_isUnlocked.configmap,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_CONFIG_MAP),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_CONFIG_MAP' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         isProtectionAllowed: true,
@@ -278,7 +277,7 @@ export const getNavItems = ({
                         href: getAppComposeURL(appId, APP_COMPOSE_STAGE.SECRETS, null, isTemplateView),
                         stage: STAGE_NAME.SECRETS,
                         isLocked: !_isUnlocked.secret,
-                        supportDocumentURL: getDocumentationUrl(DOCUMENTATION.APP_CREATE_SECRET),
+                        supportDocumentURL: getDocumentationUrl({ docLinkKey: 'APP_CREATE_SECRET' }),
                         flowCompletionPercent: completedPercent,
                         currentStep: completedSteps,
                         isProtectionAllowed: true,
@@ -293,7 +292,7 @@ export const getNavItems = ({
                                   href: `${basePath}/edit/external-links`,
                                   stage: STAGE_NAME.EXTERNAL_LINKS,
                                   isLocked: false,
-                                  supportDocumentURL: getDocumentationUrl(DOCUMENTATION.EXTERNAL_LINKS),
+                                  supportDocumentURL: getDocumentationUrl({ docLinkKey: 'EXTERNAL_LINKS' }),
                                   flowCompletionPercent: completedPercent,
                                   currentStep: completedSteps,
                               },

src/Pages/Applications/DevtronApps/Details/AppConfigurations/MainContent/DeploymentTemplate/DTChartSelector.tsx

@@ -183,7 +183,7 @@ const ChartSelectorDropdown = ({
                                          
                                         {CHART_DOCUMENTATION_LINK[chart.name] && (
                                             <DocLink
-                                                docLink={CHART_DOCUMENTATION_LINK[chart.name]}
+                                                docLinkKey={CHART_DOCUMENTATION_LINK[chart.name]}
                                                 dataTestId="chart-doc-link"
                                             />
                                         )}

src/Pages/Applications/DevtronApps/Details/AppConfigurations/MainContent/DeploymentTemplate/constants.ts

@@ -14,17 +14,17 @@
  * limitations under the License.
  */
 
-import { DOCUMENTATION, SelectPickerOptionType } from '@devtron-labs/devtron-fe-common-lib'
+import { SelectPickerOptionType } from '@devtron-labs/devtron-fe-common-lib'
 
 export const PROTECT_BASE_DEPLOYMENT_TEMPLATE_IDENTIFIER_DTO = 'BaseDeploymentTemplate' as const
 
 export const CHART_TYPE_TAB_KEYS = { DEVTRON_CHART: 'devtronChart', CUSTOM_CHARTS: 'customCharts' }
 export const CHART_TYPE_TAB = { devtronChart: 'Charts by Devtron', customCharts: 'Custom charts' }
 
 export const CHART_DOCUMENTATION_LINK = {
-    'Job & CronJob': DOCUMENTATION.JOB_CRONJOB,
-    'Rollout Deployment': DOCUMENTATION.ROLLOUT,
-    Deployment: DOCUMENTATION.DEPLOYMENT,
+    'Job & CronJob': 'JOB_CRONJOB',
+    'Rollout Deployment': 'ROLLOUT',
+    Deployment: 'DEPLOYMENT',
 }
 
 export const GUI_VIEW_TEXTS = {

src/Pages/Applications/DevtronApps/Details/AppConfigurations/Navigation/EnvironmentOverrideRouter.tsx

@@ -21,7 +21,6 @@ import {
     ConfirmationDialog,
     DeleteConfirmationModal,
     DocLink,
-    DOCUMENTATION,
     EnvResourceType,
     getEnvironmentListMinPublic,
     InfoBlock,
@@ -51,7 +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;
-        <DocLink docLink={DOCUMENTATION.APP_CREATE_ENVIRONMENT_OVERRIDE} dataTestId="env-overrides-learn-more" />
+        <DocLink docLinkKey="APP_CREATE_ENVIRONMENT_OVERRIDE" dataTestId="env-overrides-learn-more" />
     </div>
 )
 

src/Pages/GlobalConfigurations/DeploymentCharts/List/DeploymentChartsList.component.tsx

@@ -20,7 +20,6 @@ import DOMPurify from 'dompurify'
 import {
     APIResponseHandler,
     DocLink,
-    DOCUMENTATION,
     EMPTY_STATE_STATUS,
     GenericEmptyState,
     GenericFilterEmptyState,
@@ -89,10 +88,7 @@ const DeploymentChartsList = () => {
                     subTitle={
                         <>
                             Import custom charts to use them in apps instead of the default system template. &nbsp;
-                            <DocLink
-                                docLink={DOCUMENTATION.DEPLOYMENT_TEMPLATE}
-                                dataTestId="deployment-charts-list-learn-more"
-                            />
+                            <DocLink docLinkKey="DEPLOYMENT_TEMPLATE" dataTestId="deployment-charts-list-learn-more" />
                         </>
                     }
                     isButtonAvailable

src/Pages/GlobalConfigurations/DeploymentCharts/List/UploadChartModal.tsx

@@ -19,7 +19,6 @@ import { useRef, useState } from 'react'
 import {
     ButtonWithLoader,
     CustomInput,
-    DOCUMENTATION,
     getDocumentationUrl,
     noop,
     showError,
@@ -205,7 +204,7 @@ const UploadChartModal = ({ closeUploadPopup }: UploadChartModalType) => {
                     📙 Need help? 
                     <a
                         className="dc__link fw-6"
-                        href={getDocumentationUrl(DOCUMENTATION.GLOBAL_CONFIG_CUSTOM_CHART_PRE_REQUISITES)}
+                        href={getDocumentationUrl({ docLinkKey: 'GLOBAL_CONFIG_CUSTOM_CHART_PRE_REQUISITES' })}
                         target="_blank"
                         rel="noreferrer noopener"
                     >

src/Pages/Shared/ConfigMapSecret/helpers.tsx

@@ -20,7 +20,6 @@ import {
     CMSecretComponentType,
     CMSecretExternalType,
     DocLink,
-    DOCUMENTATION,
     Icon,
     InfoBlock,
     InfoColourBar,
@@ -44,7 +43,7 @@ export const renderESOInfo = (isESO: boolean) =>
                         External Secrets Operator
                     </Link>
                     &nbsp;<span>should be installed in the target cluster.</span>&nbsp;
-                    <DocLink docLink={DOCUMENTATION.EXTERNAL_SECRET} dataTestId="learn-more-about-external-secrets" />
+                    <DocLink docLinkKey="EXTERNAL_SECRET" dataTestId="learn-more-about-external-secrets" />
                 </p>
             }
         />
@@ -76,8 +75,8 @@ export const renderChartVersionBelow3090NotSupportedText = () => (
         <span className="cr-5">Supported for Chart Versions 3.10 and above.</span>&nbsp;
         <span className="cn-7">Learn more about</span>&nbsp;
         <DocLink
-            docLink={DOCUMENTATION.APP_ROLLOUT_DEPLOYMENT_TEMPLATE}
-            docLinkText="Deployment Template &gt; Chart Version"
+            docLinkKey="APP_ROLLOUT_DEPLOYMENT_TEMPLATE"
+            text="Deployment Template &gt; Chart Version"
             dataTestId="chart-version-learn-more"
         />
     </span>

src/Pages/Shared/EnvironmentOverride/EnvironmentOverrides.types.ts

@@ -16,7 +16,7 @@
 
 import React from 'react'
 
-import { AppConfigProps, DOCUMENTATION, getDocumentationUrl } from '@devtron-labs/devtron-fe-common-lib'
+import { AppConfigProps, getDocumentationUrl } from '@devtron-labs/devtron-fe-common-lib'
 
 import {
     AppConfigState,
@@ -45,12 +45,12 @@ export const SECTION_HEADING_INFO: Record<string, SectionHeadingType> = {
         title: 'ConfigMaps',
         subtitle:
             'ConfigMap is used to store common configuration variables, allowing users to unify environment variables for different modules in a distributed system into one object.',
-        learnMoreLink: getDocumentationUrl(DOCUMENTATION.APP_CREATE_CONFIG_MAP),
+        learnMoreLink: getDocumentationUrl({ docLinkKey: 'APP_CREATE_CONFIG_MAP' }),
     },
     [URLS.APP_CS_CONFIG]: {
         title: 'Secrets',
         subtitle: 'A Secret is an object that contains sensitive data such as passwords, OAuth tokens, and SSH keys.',
-        learnMoreLink: getDocumentationUrl(DOCUMENTATION.APP_CREATE_SECRET),
+        learnMoreLink: getDocumentationUrl({ docLinkKey: 'APP_CREATE_SECRET' }),
     },
 }
 

src/components/ApplicationGroup/Details/TriggerView/BulkCITrigger.tsx

@@ -42,8 +42,7 @@ import {
     uploadCIPipelineFile,
     UploadFileProps,
     savePipeline,
-    DOCUMENTATION,
-    getDocumentationUrl
+    getDocumentationUrl,
 } from '@devtron-labs/devtron-fe-common-lib'
 import Tippy from '@tippyjs/react'
 import { getCIPipelineURL, getParsedBranchValuesForPlugin, importComponentFromFELibrary } from '../../../common'
@@ -784,7 +783,7 @@ const BulkCITrigger = ({
                                 <span>{IGNORE_CACHE_INFO.BlobStorageNotConfigured.infoText}</span>
                                 <a
                                     className="fs-12 fw-6 cb-5 dc__no-decor ml-4"
-                                    href={getDocumentationUrl(DOCUMENTATION.BLOB_STORAGE)}
+                                    href={getDocumentationUrl({ docLinkKey: 'BLOB_STORAGE' })}
                                     target="_blank"
                                     rel="noreferrer"
                                 >