Skip to content

Commit d2a0c94

Browse files
committed
chore: doc link updated
1 parent e6de32d commit d2a0c94

File tree

9 files changed

+20
-26
lines changed

9 files changed

+20
-26
lines changed

src/Pages/App/CreateAppModal/Sidebar.tsx

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

17-
import { getDocumentationUrl, ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
17+
import { ModalSidebarPanel } from '@devtron-labs/devtron-fe-common-lib'
1818

1919
import { CreationMethodType, SidebarProps } from './types'
2020

@@ -55,7 +55,7 @@ const Sidebar = ({
5555
<div className="divider__secondary--horizontal" />
5656
<ModalSidebarPanel
5757
heading={null}
58-
documentationLink={getDocumentationUrl({ docLinkKey: 'APP_CREATE' })}
58+
documentationLink="APP_CREATE"
5959
rootClassName="w-100 dc__no-background-imp"
6060
>
6161
<div className="flexbox-col dc__gap-24">

src/Pages/GlobalConfigurations/Authorization/PermissionGroups/List/PermissionGroupListHeader.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import {
2020
Button,
2121
ButtonComponentType,
2222
ComponentSizeType,
23-
DOCUMENTATION,
2423
FeatureTitleWithInfo,
2524
SearchBar,
2625
useMainContext,
@@ -47,7 +46,7 @@ const PermissionGroupListHeader = ({
4746
renderDescriptionContent={() =>
4847
'Permission groups allow you to easily manage user permissions by assigning desired permissions to a group and assigning these groups to users to provide all underlying permissions.'
4948
}
50-
docLink={DOCUMENTATION.GLOBAL_CONFIG_GROUPS}
49+
docLink="GLOBAL_CONFIG_GROUPS"
5150
showInfoIconTippy
5251
/>
5352
</div>

src/Pages/GlobalConfigurations/Authorization/SSOLoginServices/SSOLogin.component.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ import {
3737
ConfirmationModalVariantType,
3838
CustomInput,
3939
DEFAULT_SECRET_PLACEHOLDER,
40-
DOCUMENTATION,
4140
ErrorScreenManager,
4241
FeatureTitleWithInfo,
4342
InfoBlock,
@@ -834,7 +833,7 @@ class SSOLogin extends Component<SSOLoginProps, SSOLoginState> {
834833
<FeatureTitleWithInfo
835834
title={HEADER_TEXT.SSO_LOGIN.title}
836835
renderDescriptionContent={() => HEADER_TEXT.SSO_LOGIN.description}
837-
docLink={DOCUMENTATION.GLOBAL_CONFIG_SSO}
836+
docLink="GLOBAL_CONFIG_SSO"
838837
showInfoIconTippy
839838
dataTestId="sso-login-heading"
840839
/>

src/Pages/GlobalConfigurations/Authorization/UserPermissions/List/UserPermissionListHeader.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import {
2020
Button,
2121
ButtonComponentType,
2222
ComponentSizeType,
23-
DOCUMENTATION,
2423
FeatureTitleWithInfo,
2524
SearchBar,
2625
useMainContext,
@@ -53,7 +52,7 @@ const UserPermissionListHeader = ({
5352
renderDescriptionContent={() =>
5453
"Manage your organization's users and their permissions. You can assign users to permission groups to provide all underlying permissions."
5554
}
56-
docLink={DOCUMENTATION.GLOBAL_CONFIG_USER}
55+
docLink="GLOBAL_CONFIG_USER"
5756
showInfoIconTippy
5857
/>
5958
</div>

src/components/charts/list/DiscoverCharts.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -825,7 +825,7 @@ export const ChartGroupListMin = ({
825825
renderDescriptionContent={() =>
826826
'Use chart groups to pre-configure and deploy frequently used charts together.'
827827
}
828-
docLink={'CHART_GROUP'}
828+
docLink='CHART_GROUP'
829829
docLinkText="Learn more"
830830
dataTestId="chart-store"
831831
showInfoIconTippy

src/components/cluster/Cluster.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import {
2121
ErrorScreenNotAuthorized,
2222
Reload,
2323
Drawer,
24-
DOCUMENTATION,
2524
sortCallback,
2625
noop,
2726
DEFAULT_SECRET_PLACEHOLDER,
@@ -244,7 +243,7 @@ class ClusterList extends Component<ClusterListProps, any> {
244243
<FeatureTitleWithInfo
245244
title={moduleBasedTitle}
246245
renderDescriptionContent={() => `Manage your organization’s ${moduleBasedTitle.toLowerCase()}.`}
247-
docLink={DOCUMENTATION.GLOBAL_CONFIG_CLUSTER}
246+
docLink="GLOBAL_CONFIG_CLUSTER"
248247
showInfoIconTippy
249248
additionalContainerClasses="mb-20"
250249
/>

src/components/hostURL/HostURL.tsx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ const renderInfoContent = () => (
3737
<>
3838
Host URL is the domain address at which your devtron dashboard can be reached.
3939
<br />
40-
It is used to reach your devtron dashboard from external sources like configured webhooks, e-mail or
41-
slack notifications, grafana dashboard, etc.
40+
It is used to reach your devtron dashboard from external sources like configured webhooks, e-mail or slack
41+
notifications, grafana dashboard, etc.
4242
</>
4343
)
4444
export default class HostURLConfiguration extends Component<HostURLConfigProps, HostURLConfigState> {
@@ -208,8 +208,6 @@ export default class HostURLConfiguration extends Component<HostURLConfigProps,
208208
)
209209
}
210210

211-
212-
213211
return (
214212
<section
215213
className="flex column left top bg__primary h-100 dc__gap-24 px-20 py-16"

src/components/notifications/Notifications.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export default class Notifications extends Component<NotificationsProps, {}> {
3535
<FeatureTitleWithInfo
3636
title={HEADER_TEXT.NOTIFICATIONS.title}
3737
renderDescriptionContent={() => HEADER_TEXT.NOTIFICATIONS.description}
38-
docLink={DOCUMENTATION.GLOBAL_CONFIG_NOTIFICATION}
38+
docLink="GLOBAL_CONFIG_NOTIFICATION"
3939
showInfoIconTippy
4040
dataTestId="notifications-feature-title"
4141
/>

src/config/constants.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -327,51 +327,51 @@ export const MomentDateFormat = 'ddd, DD MMM YYYY'
327327
export const Moment12HourExportFormat = 'DD-MMM-YYYY hh.mm A'
328328
export const MomentInvalidDate = 'Invalid date'
329329

330-
export const HEADER_TEXT = {
330+
export const HEADER_TEXT: Record<string, { title: string; description: string; docLink: keyof typeof DOCUMENTATION }> = {
331331
API_TOKEN: {
332332
title: 'API Token',
333333
description: 'Tokens you have generated that can be used to access the Devtron API.',
334-
docLink: DOCUMENTATION.GLOBAL_CONFIG_API_TOKEN,
334+
docLink: "GLOBAL_CONFIG_API_TOKEN"
335335
},
336336
CHART_REPOSITORY: {
337337
title: 'Chart Repository',
338338
description: 'Manage your organization’s chart repositories.',
339-
docLink: DOCUMENTATION.GLOBAL_CONFIG_CHART,
339+
docLink: "GLOBAL_CONFIG_CHART"
340340
},
341341
HOST_URL: {
342342
title: 'Host URL',
343343
description: 'Host URL is the domain address at which your devtron dashboard can be reached.',
344-
docLink: DOCUMENTATION.GLOBAL_CONFIG_HOST_URL,
344+
docLink: "GLOBAL_CONFIG_HOST_URL"
345345
},
346346
GITOPS: {
347347
title: 'GitOps',
348348
description: 'Devtron uses GitOps configuration to store kubernetes configuration files of applications.',
349-
docLink: DOCUMENTATION.GLOBAL_CONFIG_GITOPS,
349+
docLink: "GLOBAL_CONFIG_GITOPS"
350350
},
351351
GIT_ACCOUNTS: {
352352
title: 'Git Accounts',
353353
description: 'Manage your organization’s git accounts.',
354-
docLink: DOCUMENTATION.GLOBAL_CONFIG_GIT,
354+
docLink: "GLOBAL_CONFIG_GIT"
355355
},
356356
NOTIFICATIONS: {
357357
title: 'Notifications',
358358
description: 'Manage notifications for build and deployment pipelines.',
359-
docLink: DOCUMENTATION.GLOBAL_CONFIG_NOTIFICATION,
359+
docLink: "GLOBAL_CONFIG_NOTIFICATION"
360360
},
361361
PROJECTS: {
362362
title: 'Projects',
363363
description: "Manage your organization's projects.",
364-
docLink: DOCUMENTATION.GLOBAL_CONFIG_PROJECT,
364+
docLink: "GLOBAL_CONFIG_PROJECT"
365365
},
366366
SSO_LOGIN: {
367367
title: 'SSO Login Service',
368368
description: 'Configure and manage login service for your organization.',
369-
docLink: DOCUMENTATION.GLOBAL_CONFIG_SSO,
369+
docLink: "GLOBAL_CONFIG_SSO"
370370
},
371371
SCOPED_VARIABLES: {
372372
title: 'Scoped Variables',
373373
description: 'Scoped variables are used to define environment-specific variables.',
374-
docLink: DOCUMENTATION.GLOBAL_CONFIG_SCOPED_VARIABLES,
374+
docLink: "GLOBAL_CONFIG_SCOPED_VARIABLES"
375375
},
376376
}
377377

0 commit comments

Comments
 (0)