Skip to content

Commit 5c186f8

Browse files
shivani170shivani170
committed
chore: Documentation constant added in doc link component
1 parent 82a037e commit 5c186f8

7 files changed

Lines changed: 79 additions & 22 deletions

File tree

‎src/Common/Constants.ts‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,6 @@ export const DEVTRON_HOME_PAGE = 'https://devtron.ai/'
2222
export const DOCUMENTATION_VERSION = '/v/v0.7'
2323
export const DISCORD_LINK = 'https://discord.devtron.ai/'
2424
export const DEFAULT_JSON_SCHEMA_URI = 'https://json-schema.org/draft/2020-12/schema'
25-
export const DOCUMENTATION = {
26-
APP_METRICS: `usage/applications/app-details/app-metrics`,
27-
APP_TAGS: `usage/applications/create-application#tags`,
28-
APP_OVERVIEW_TAGS: `usage/applications/overview#manage-tags`,
29-
BLOB_STORAGE: `getting-started/install/installation-configuration#configuration-of-blob-storage`,
30-
GLOBAL_CONFIG_BUILD_INFRA: `global-configurations/build-infra`,
31-
ENTERPRISE_LICENSE: `enterprise-license`,
32-
KUBE_CONFIG: `usage/resource-browser#running-kubectl-commands-locally`,
33-
TENANT_INSTALLATION: `${DOCUMENTATION_HOME_PAGE}${DOCUMENTATION_VERSION}/usage/software-distribution-hub/tenants`,
34-
}
3525

3626
export const PATTERNS = {
3727
STRING: /^[a-zA-Z0-9_]+$/,

‎src/Common/CustomTagSelector/PropagateTagInfo.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import { ReactComponent as InjectTag } from '../../Assets/Icon/inject-tag.svg'
1919
import { ReactComponent as ICHelpOutline } from '../../Assets/Icon/ic-help-outline.svg'
2020
import { TippyCustomized } from '../TippyCustomized'
2121
import { TippyTheme } from '../Types'
22-
import { DOCUMENTATION } from '../Constants'
23-
import { getDocumentationUrl } from '@Common/DocLink'
22+
23+
import { DOCUMENTATION } from '@Common/DocLink'
2424

2525
export default function PropagateTagInfo({ isCreateApp }: { isCreateApp: boolean }) {
2626
const additionalInfo = () => (
@@ -48,7 +48,7 @@ export default function PropagateTagInfo({ isCreateApp }: { isCreateApp: boolean
4848
showCloseButton
4949
trigger="click"
5050
interactive
51-
documentationLink={isCreateApp ? getDocumentationUrl(DOCUMENTATION.APP_TAGS) : getDocumentationUrl(DOCUMENTATION.APP_OVERVIEW_TAGS)}
51+
documentationLink={isCreateApp ? DOCUMENTATION.APP_TAGS : DOCUMENTATION.APP_OVERVIEW_TAGS}
5252
documentationLinkText="View Documentation"
5353
>
5454
<div className="flexbox cursor">

‎src/Common/DocLink/constants.ts‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
import { DOCUMENTATION_HOME_PAGE, DOCUMENTATION_VERSION } from '@Common/Constants'
2+
3+
export const DOCUMENTATION = {
4+
ADMIN_PASSWORD: 'install/install-devtron#devtron-admin-credentials',
5+
APP_CI_CONFIG_BUILD_WITHOUT_DOCKER:
6+
'usage/applications/creating-application/docker-build-configuration#build-docker-image-without-dockerfile',
7+
APP_CREATE: 'usage/applications/create-application',
8+
APP_CREATE_CI_CONFIG: 'usage/applications/creating-application/docker-build-configuration',
9+
APP_CREATE_CONFIG_MAP: 'usage/applications/creating-application/config-maps',
10+
APP_CREATE_ENVIRONMENT_OVERRIDE: 'usage/applications/creating-application/environment-overrides',
11+
APP_CREATE_MATERIAL: 'usage/applications/creating-application/git-material',
12+
APP_CREATE_SECRET: 'usage/applications/creating-application/secrets',
13+
APP_CREATE_WORKFLOW: 'usage/applications/creating-application/workflow',
14+
APP_DEPLOYMENT_TEMPLATE: 'usage/applications/creating-application/deployment-template',
15+
APP_EPHEMERAL_CONTAINER: 'usage/applications/app-details/ephemeral-containers',
16+
APP_METRICS: 'usage/applications/app-details/app-metrics',
17+
APP_OVERVIEW_TAGS: 'usage/applications/overview#manage-tags',
18+
APP_ROLLOUT_DEPLOYMENT_TEMPLATE: 'usage/applications/creating-application/deployment-template/rollout-deployment',
19+
BUILD_STAGE: 'usage/applications/creating-application/ci-pipeline#build-stage',
20+
APP_TAGS: 'usage/applications/create-application#tags',
21+
BLOB_STORAGE: 'getting-started/install/installation-configuration#configuration-of-blob-storage',
22+
BULK_UPDATE: 'usage/bulk-update',
23+
CHART_GROUP: 'usage/deploy-chart/chart-group',
24+
CHART_LIST: 'usage/deploy-chart/overview-of-charts',
25+
CUSTOM_VALUES: 'usage/deploy-chart/overview-of-charts#custom-values',
26+
DEPLOYMENT: 'usage/applications/creating-application/deployment-template/deployment',
27+
DEPLOYMENT_TEMPLATE: 'usage/applications/creating-application/deployment-template',
28+
DEVTRON_UPGRADE: 'getting-started/upgrade',
29+
CONFIGURING_WEBHOOK: 'usage/applications/creating-application/workflow/ci-pipeline#configuring-webhook',
30+
ENTERPRISE_LICENSE: 'enterprise-license',
31+
EXECUTE_CUSTOM_SCRIPT:
32+
'usage/applications/creating-application/workflow/ci-pipeline/ci-build-pre-post-plugins#execute-custom-script',
33+
EXTERNAL_LINKS: 'getting-started/global-configurations/external-links',
34+
EXTERNAL_SECRET: 'usage/applications/creating-application/secrets#external-secrets',
35+
KUBE_CONFIG: 'usage/resource-browser#running-kubectl-commands-locally',
36+
37+
// Global Configurations
38+
GLOBAL_CONFIG_API_TOKEN: 'getting-started/global-configurations/authorization/api-tokens',
39+
GLOBAL_CONFIG_BUILD_INFRA: 'global-configurations/build-infra',
40+
GLOBAL_CONFIG_CHART: 'getting-started/global-configurations/chart-repo',
41+
GLOBAL_CONFIG_CLUSTER: 'getting-started/global-configurations/cluster-and-environments',
42+
GLOBAL_CONFIG_CUSTOM_CHART: 'getting-started/global-configurations/custom-charts',
43+
GLOBAL_CONFIG_CUSTOM_CHART_PRE_REQUISITES: 'getting-started/global-configurations/custom-charts#prerequisites',
44+
GLOBAL_CONFIG_DOCKER: 'getting-started/global-configurations/container-registries',
45+
GLOBAL_CONFIG_GIT: 'getting-started/global-configurations/git-accounts',
46+
GLOBAL_CONFIG_GITOPS: 'getting-started/global-configurations/gitops',
47+
GLOBAL_CONFIG_GITOPS_GITHUB: 'global-configurations/gitops#github',
48+
GLOBAL_CONFIG_GITOPS_GITLAB: 'global-configurations/gitops#gitlab',
49+
GLOBAL_CONFIG_GITOPS_AZURE: 'global-configurations/gitops#azure',
50+
GLOBAL_CONFIG_GITOPS_BITBUCKET: 'global-configurations/gitops#bitbucket',
51+
GLOBAL_CONFIG_GROUPS: 'getting-started/global-configurations/authorization/permission-groups',
52+
GLOBAL_CONFIG_HOST_URL: 'getting-started/global-configurations/host-url',
53+
GLOBAL_CONFIG_NOTIFICATION: 'getting-started/global-configurations/manage-notification',
54+
GLOBAL_CONFIG_PERMISSION: `${DOCUMENTATION_HOME_PAGE}/global-configurations/authorization/user-access#devtron-apps-permissions`,
55+
GLOBAL_CONFIG_PROJECT: 'getting-started/global-configurations/projects',
56+
GLOBAL_CONFIG_SSO: 'getting-started/global-configurations/sso-login',
57+
GLOBAL_CONFIG_SCOPED_VARIABLES: 'getting-started/global-configurations/scoped-variables',
58+
GLOBAL_CONFIG_USER: 'getting-started/global-configurations/authorization/user-access',
59+
HYPERION: `${DOCUMENTATION_HOME_PAGE}/#hyperion`,
60+
JOB_CRONJOB: 'usage/applications/creating-application/deployment-template/job-and-cronjob',
61+
JOB_SOURCE_CODE: 'usage/jobs/configuration-job',
62+
JOB_WORKFLOW_EDITOR: 'usage/jobs/workflow-editor-job',
63+
K8S_RESOURCES_PERMISSIONS: 'global-configurations/authorization/user-access#kubernetes-resources-permissions',
64+
MANDATORY_TAGS: `${DOCUMENTATION_HOME_PAGE}/global-configurations/tags-policy#create-application-with-mandatory-tags`,
65+
PRE_POST_BUILD_STAGE: 'usage/applications/creating-application/ci-pipeline/ci-build-pre-post-plugins',
66+
ROLLOUT: 'usage/applications/creating-application/deployment-template/rollout-deployment',
67+
SECURITY: 'usage/security-features',
68+
SPECIFY_IMAGE_PULL_SECRET: 'getting-started/global-configurations/container-registries#specify-image-pull-secret',
69+
TENANT_INSTALLATION: `${DOCUMENTATION_HOME_PAGE}${DOCUMENTATION_VERSION}/usage/software-distribution-hub/tenants`,
70+
}

‎src/Common/DocLink/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
export { DOCUMENTATION } from './constants'
12
export { DocLink, getDocumentationUrl } from './DocLink'

‎src/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/DTApplicationMetricsFormField.tsx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616

1717
import { ReactComponent as ICInfoFilledOverride } from '@Icons/ic-info-filled-override.svg'
1818
import { Checkbox } from '@Common/Checkbox'
19-
import { DOCUMENTATION } from '@Common/Constants'
20-
import { getDocumentationUrl } from '@Common/DocLink'
19+
import { DOCUMENTATION } from '@Common/index'
2120
import { Progressing } from '@Common/Progressing'
2221
import { Tooltip } from '@Common/Tooltip'
2322
import { CHECKBOX_VALUE } from '@Common/Types'
@@ -97,7 +96,7 @@ const DTApplicationMetricsFormField = ({
9796
<InfoIconTippy
9897
heading="Application Metrics"
9998
infoText="Capture and show key application metrics over time. (E.g. Status codes 2xx, 3xx, 5xx; throughput and latency)."
100-
documentationLink={getDocumentationUrl(DOCUMENTATION.APP_METRICS)}
99+
documentationLink={DOCUMENTATION.APP_METRICS}
101100
documentationLinkText="Learn more"
102101
dataTestid="app-metrics-info"
103102
iconClassName="dc__no-shrink icon-dim-16 fcn-6"

‎src/Pages/GlobalConfigurations/BuildInfra/Descriptor.tsx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
* limitations under the License.
1515
*/
1616

17-
import { getDocumentationUrl } from '@Common/DocLink'
1817
import { InfoIconTippy } from '@Shared/Components/InfoIconTippy'
1918

2019
import { BreadCrumb, DOCUMENTATION } from '../../../Common'
@@ -39,7 +38,7 @@ const Descriptor = ({
3938
infoText={tippyInfoText ?? BUILD_INFRA_TEXT.EDIT_DEFAULT_TOOLTIP}
4039
additionalContent={tippyAdditionalContent}
4140
heading={tooltipHeading || BUILD_INFRA_TEXT.HEADING}
42-
documentationLink={getDocumentationUrl(DOCUMENTATION.GLOBAL_CONFIG_BUILD_INFRA)}
41+
documentationLink={DOCUMENTATION.GLOBAL_CONFIG_BUILD_INFRA}
4342
documentationLinkText="View Documentation"
4443
iconClassName="icon-dim-20 fcn-6"
4544
/>

‎src/Shared/Components/License/License.components.tsx‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@ import { useEffect, useRef, useState } from 'react'
22

33
import { ReactComponent as ICCheck } from '@Icons/ic-check.svg'
44
import { ReactComponent as ICClipboard } from '@Icons/ic-copy.svg'
5-
import { DOCUMENTATION } from '@Common/Constants'
6-
import { getDocumentationUrl } from '@Common/DocLink'
7-
import { ClipboardButton, copyToClipboard, showError } from '@Common/index'
5+
import { ClipboardButton, copyToClipboard, DOCUMENTATION, showError } from '@Common/index'
86

97
import { Backdrop, Button, ButtonStyleType, ButtonVariantType, Icon, InfoIconTippy, QRCode } from '..'
108
import { CopyButtonProps, GatekeeperQRDialogProps, InstallFingerprintInfoProps } from './types'
@@ -91,7 +89,7 @@ const InstallationFingerprintInfo = ({ fingerprint, showHelpTooltip = false }: I
9189
documentationLinkText="Documentation"
9290
iconClassName="icon-dim-20 fcn-6"
9391
placement="right"
94-
documentationLink={getDocumentationUrl(DOCUMENTATION.ENTERPRISE_LICENSE)}
92+
documentationLink={DOCUMENTATION.ENTERPRISE_LICENSE}
9593
/>
9694
)}
9795
</div>

0 commit comments

Comments
 (0)