Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd8acb48

Browse files
BrunoQuaresmapull[bot]
authored andcommitted
feat(site): add support for custom docs url (#8601)
1 parent6a3a807 commitd8acb48

File tree

24 files changed

+92
-47
lines changed

24 files changed

+92
-47
lines changed

‎site/src/components/Dashboard/DashboardLayout.tsx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import Link from "@mui/material/Link"
1515
importBoxfrom"@mui/material/Box"
1616
importInfoOutlinedfrom"@mui/icons-material/InfoOutlined"
1717
importButtonfrom"@mui/material/Button"
18+
import{docs}from"utils/docs"
1819

1920
exportconstDashboardLayout:FC=()=>{
2021
conststyles=useStyles()
@@ -79,9 +80,7 @@ export const DashboardLayout: FC = () => {
7980
<Box>
8081
Coder{updateCheck?.version} is now available. View the{" "}
8182
<Linkhref={updateCheck?.url}>release notes</Link> and{" "}
82-
<Linkhref="https://coder.com/docs/coder-oss/latest/admin/upgrade">
83-
upgrade instructions
84-
</Link>{" "}
83+
<Linkhref={docs("/admin/upgrade")}>upgrade instructions</Link>{" "}
8584
for more information.
8685
</Box>
8786
</Box>

‎site/src/components/PortForwardButton/PortForwardButton.tsx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { Maybe } from "components/Conditionals/Maybe"
1717
import{useMachine}from"@xstate/react"
1818
import{portForwardMachine}from"xServices/portForward/portForwardXService"
1919
import{SecondaryAgentButton}from"components/Resources/AgentButton"
20+
import{docs}from"utils/docs"
2021

2122
exportinterfacePortForwardButtonProps{
2223
host:string
@@ -129,7 +130,7 @@ const TooltipView: React.FC<PortForwardButtonProps> = (props) => {
129130
</Maybe>
130131

131132
<HelpTooltipLinksGroup>
132-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/networking/port-forwarding#dashboard">
133+
<HelpTooltipLinkhref={docs("/networking/port-forwarding#dashboard")}>
133134
Learn more about web port forwarding
134135
</HelpTooltipLink>
135136
</HelpTooltipLinksGroup>

‎site/src/components/SSHButton/SSHButton.tsx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
HelpTooltipLinksGroup,
1010
HelpTooltipText,
1111
}from"../Tooltips/HelpTooltip"
12+
import{docs}from"utils/docs"
1213

1314
exportinterfaceSSHButtonProps{
1415
workspaceName:string
@@ -85,16 +86,16 @@ export const SSHButton: React.FC<React.PropsWithChildren<SSHButtonProps>> = ({
8586
</Stack>
8687

8788
<HelpTooltipLinksGroup>
88-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/install">
89+
<HelpTooltipLinkhref={docs("/install")}>
8990
Install Coder CLI
9091
</HelpTooltipLink>
91-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/ides#vs-code-remote">
92+
<HelpTooltipLinkhref={docs("/ides#vs-code-remote")}>
9293
Connect via VS Code Remote SSH
9394
</HelpTooltipLink>
94-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/ides#jetbrains-gateway">
95+
<HelpTooltipLinkhref={docs("/ides#jetbrains-gateway")}>
9596
Connect via JetBrains Gateway
9697
</HelpTooltipLink>
97-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/ides#ssh-configuration">
98+
<HelpTooltipLinkhref={docs("/ides#ssh-configuration")}>
9899
SSH configuration
99100
</HelpTooltipLink>
100101
</HelpTooltipLinksGroup>

‎site/src/components/Tooltips/AuditHelpTooltip.tsx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
HelpTooltipText,
77
HelpTooltipTitle,
88
}from"./HelpTooltip"
9+
import{docs}from"utils/docs"
910

1011
exportconstLanguage={
1112
title:"What is an audit log?",
@@ -19,7 +20,7 @@ export const AuditHelpTooltip: FC = () => {
1920
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
2021
<HelpTooltipText>{Language.body}</HelpTooltipText>
2122
<HelpTooltipLinksGroup>
22-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/admin/audit-logs">
23+
<HelpTooltipLinkhref={docs("/admin/audit-logs")}>
2324
{Language.docs}
2425
</HelpTooltipLink>
2526
</HelpTooltipLinksGroup>

‎site/src/components/Tooltips/UserRoleHelpTooltip.tsx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
HelpTooltipText,
77
HelpTooltipTitle,
88
}from"./HelpTooltip"
9+
import{docs}from"utils/docs"
910

1011
exportconstLanguage={
1112
title:"What is a role?",
@@ -21,7 +22,7 @@ export const UserRoleHelpTooltip: FC = () => {
2122
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
2223
<HelpTooltipText>{Language.text}</HelpTooltipText>
2324
<HelpTooltipLinksGroup>
24-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/admin/users#roles">
25+
<HelpTooltipLinkhref={docs("/admin/users#roles")}>
2526
{Language.link}
2627
</HelpTooltipLink>
2728
</HelpTooltipLinksGroup>

‎site/src/components/Tooltips/WorkspaceHelpTooltip.tsx‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import {
66
HelpTooltipText,
77
HelpTooltipTitle,
88
}from"./HelpTooltip"
9+
import{docs}from"utils/docs"
910

1011
constLanguage={
1112
workspaceTooltipTitle:"What is a workspace?",
@@ -22,13 +23,13 @@ export const WorkspaceHelpTooltip: FC = () => {
2223
<HelpTooltipTitle>{Language.workspaceTooltipTitle}</HelpTooltipTitle>
2324
<HelpTooltipText>{Language.workspaceTooltipText}</HelpTooltipText>
2425
<HelpTooltipLinksGroup>
25-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/workspaces#create-workspaces">
26+
<HelpTooltipLinkhref={docs("/workspaces#create-workspaces")}>
2627
{Language.workspaceTooltipLink1}
2728
</HelpTooltipLink>
28-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/workspaces#connect-with-ssh">
29+
<HelpTooltipLinkhref={docs("/workspaces#connect-with-ssh")}>
2930
{Language.workspaceTooltipLink2}
3031
</HelpTooltipLink>
31-
<HelpTooltipLinkhref="https://coder.com/docs/coder-oss/latest/workspaces#editors-and-ides">
32+
<HelpTooltipLinkhref={docs("/workspaces#editors-and-ides")}>
3233
{Language.workspaceTooltipLink3}
3334
</HelpTooltipLink>
3435
</HelpTooltipLinksGroup>

‎site/src/components/WorkspaceActions/BuildParametersPopover.tsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import {
2020
}from"components/Tooltips/HelpTooltip/HelpTooltip"
2121
import{useFormik}from"formik"
2222
import{useRef,useState}from"react"
23+
import{docs}from"utils/docs"
2324
import{getFormHelpers}from"utils/formUtils"
2425
import{getInitialParameterValues}from"utils/richParameters"
2526

@@ -118,7 +119,9 @@ export const BuildParametersPopover = ({
118119
This template has no ephemeral build options.
119120
</HelpTooltipText>
120121
<HelpTooltipLinksGroup>
121-
<HelpTooltipLinkhref="https://coder.com/docs/v2/latest/templates/parameters#ephemeral-parameters">
122+
<HelpTooltipLink
123+
href={docs("/templates/parameters#ephemeral-parameters")}
124+
>
122125
Read the docs
123126
</HelpTooltipLink>
124127
</HelpTooltipLinksGroup>

‎site/src/pages/AuditPage/AuditFilter.tsx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {
1111
import{UseFilterMenuOptions,useFilterMenu}from"components/Filter/menu"
1212
import{BaseOption}from"components/Filter/options"
1313
importcapitalizefrom"lodash/capitalize"
14+
import{docs}from"utils/docs"
1415

1516
constPRESET_FILTERS=[
1617
{
@@ -44,7 +45,7 @@ export const AuditFilter = ({
4445
})=>{
4546
return(
4647
<Filter
47-
learnMoreLink="https://coder.com/docs/v2/latest/admin/audit-logs#filtering-logs"
48+
learnMoreLink={docs("/admin/audit-logs#filtering-logs")}
4849
presets={PRESET_FILTERS}
4950
isLoading={menus.user.isInitializing}
5051
filter={filter}

‎site/src/pages/AuditPage/AuditPaywall.tsx‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { Paywall } from "components/Paywall/Paywall"
55
import{Stack}from"components/Stack/Stack"
66
import{FC}from"react"
77
import{useTranslation}from"react-i18next"
8+
import{docs}from"utils/docs"
89

910
exportconstAuditPaywall:FC=()=>{
1011
const{ t}=useTranslation("auditLog")
@@ -15,17 +16,13 @@ export const AuditPaywall: FC = () => {
1516
description={t("paywall.description")}
1617
cta={
1718
<Stackdirection="row"alignItems="center">
18-
<Link
19-
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
20-
target="_blank"
21-
rel="noreferrer"
22-
>
19+
<Linkhref={docs("/admin/upgrade")}target="_blank"rel="noreferrer">
2320
<Buttonsize="small"startIcon={<ArrowRightAltOutlined/>}>
2421
{t("paywall.actions.upgrade")}
2522
</Button>
2623
</Link>
2724
<Link
28-
href="https://coder.com/docs/coder-oss/latest/admin/audit-logs"
25+
href={docs("/admin/audit-logs")}
2926
target="_blank"
3027
rel="noreferrer"
3128
>

‎site/src/pages/CreateTemplatePage/CreateTemplateForm.tsx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import {
3939
importcamelCasefrom"lodash/camelCase"
4040
importcapitalizefrom"lodash/capitalize"
4141
import{VariableInput}from"./VariableInput"
42+
import{docs}from"utils/docs"
4243

4344
constMAX_DESCRIPTION_CHAR_LIMIT=128
4445
constMAX_TTL_DAYS=30
@@ -322,7 +323,7 @@ export const CreateTemplateForm: FC<CreateTemplateFormProps> = ({
322323
) :(
323324
<>
324325
{commonT("licenseFieldTextHelper")}{" "}
325-
<Linkhref="https://coder.com/docs/v2/latest/enterprise">
326+
<Linkhref={docs("/enterprise")}>
326327
{commonT("learnMore")}
327328
</Link>
328329
.
@@ -459,7 +460,7 @@ export const CreateTemplateForm: FC<CreateTemplateFormProps> = ({
459460
</Stack>
460461
<spanclassName={styles.optionHelperText}>
461462
This setting requires an enterprise license for the&nbsp;
462-
<Linkhref="https://coder.com/docs/v2/latest/admin/rbac">
463+
<Linkhref={docs("/admin/rbac")}>
463464
&apos;Template RBAC&apos;
464465
</Link>{" "}
465466
feature to customize permissions.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp