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

feat(site): add support for custom docs url#8601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
BrunoQuaresma merged 1 commit intomainfrombq/custom-docs-url
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletionssite/src/components/Dashboard/DashboardLayout.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import Link from "@mui/material/Link"
import Box from "@mui/material/Box"
import InfoOutlined from "@mui/icons-material/InfoOutlined"
import Button from "@mui/material/Button"
import { docs } from "utils/docs"

export const DashboardLayout: FC = () => {
const styles = useStyles()
Expand DownExpand Up@@ -79,9 +80,7 @@ export const DashboardLayout: FC = () => {
<Box>
Coder {updateCheck?.version} is now available. View the{" "}
<Link href={updateCheck?.url}>release notes</Link> and{" "}
<Link href="https://coder.com/docs/coder-oss/latest/admin/upgrade">
upgrade instructions
</Link>{" "}
<Link href={docs("/admin/upgrade")}>upgrade instructions</Link>{" "}
for more information.
</Box>
</Box>
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { Maybe } from "components/Conditionals/Maybe"
import { useMachine } from "@xstate/react"
import { portForwardMachine } from "xServices/portForward/portForwardXService"
import { SecondaryAgentButton } from "components/Resources/AgentButton"
import { docs } from "utils/docs"

export interface PortForwardButtonProps {
host: string
Expand DownExpand Up@@ -129,7 +130,7 @@ const TooltipView: React.FC<PortForwardButtonProps> = (props) => {
</Maybe>

<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/networking/port-forwarding#dashboard">
<HelpTooltipLink href={docs("/networking/port-forwarding#dashboard")}>
Learn more about web port forwarding
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
9 changes: 5 additions & 4 deletionssite/src/components/SSHButton/SSHButton.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
HelpTooltipLinksGroup,
HelpTooltipText,
} from "../Tooltips/HelpTooltip"
import { docs } from "utils/docs"

export interface SSHButtonProps {
workspaceName: string
Expand DownExpand Up@@ -85,16 +86,16 @@ export const SSHButton: React.FC<React.PropsWithChildren<SSHButtonProps>> = ({
</Stack>

<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/install">
<HelpTooltipLink href={docs("/install")}>
Install Coder CLI
</HelpTooltipLink>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/ides#vs-code-remote">
<HelpTooltipLink href={docs("/ides#vs-code-remote")}>
Connect via VS Code Remote SSH
</HelpTooltipLink>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/ides#jetbrains-gateway">
<HelpTooltipLink href={docs("/ides#jetbrains-gateway")}>
Connect via JetBrains Gateway
</HelpTooltipLink>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/ides#ssh-configuration">
<HelpTooltipLink href={docs("/ides#ssh-configuration")}>
SSH configuration
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
3 changes: 2 additions & 1 deletionsite/src/components/Tooltips/AuditHelpTooltip.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
HelpTooltipText,
HelpTooltipTitle,
} from "./HelpTooltip"
import { docs } from "utils/docs"

export const Language = {
title: "What is an audit log?",
Expand All@@ -19,7 +20,7 @@ export const AuditHelpTooltip: FC = () => {
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
<HelpTooltipText>{Language.body}</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/admin/audit-logs">
<HelpTooltipLink href={docs("/admin/audit-logs")}>
{Language.docs}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
3 changes: 2 additions & 1 deletionsite/src/components/Tooltips/UserRoleHelpTooltip.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
HelpTooltipText,
HelpTooltipTitle,
} from "./HelpTooltip"
import { docs } from "utils/docs"

export const Language = {
title: "What is a role?",
Expand All@@ -21,7 +22,7 @@ export const UserRoleHelpTooltip: FC = () => {
<HelpTooltipTitle>{Language.title}</HelpTooltipTitle>
<HelpTooltipText>{Language.text}</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/admin/users#roles">
<HelpTooltipLink href={docs("/admin/users#roles")}>
{Language.link}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
7 changes: 4 additions & 3 deletionssite/src/components/Tooltips/WorkspaceHelpTooltip.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import {
HelpTooltipText,
HelpTooltipTitle,
} from "./HelpTooltip"
import { docs } from "utils/docs"

const Language = {
workspaceTooltipTitle: "What is a workspace?",
Expand All@@ -22,13 +23,13 @@ export const WorkspaceHelpTooltip: FC = () => {
<HelpTooltipTitle>{Language.workspaceTooltipTitle}</HelpTooltipTitle>
<HelpTooltipText>{Language.workspaceTooltipText}</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/workspaces#create-workspaces">
<HelpTooltipLink href={docs("/workspaces#create-workspaces")}>
{Language.workspaceTooltipLink1}
</HelpTooltipLink>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/workspaces#connect-with-ssh">
<HelpTooltipLink href={docs("/workspaces#connect-with-ssh")}>
{Language.workspaceTooltipLink2}
</HelpTooltipLink>
<HelpTooltipLink href="https://coder.com/docs/coder-oss/latest/workspaces#editors-and-ides">
<HelpTooltipLink href={docs("/workspaces#editors-and-ides")}>
{Language.workspaceTooltipLink3}
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import {
} from "components/Tooltips/HelpTooltip/HelpTooltip"
import { useFormik } from "formik"
import { useRef, useState } from "react"
import { docs } from "utils/docs"
import { getFormHelpers } from "utils/formUtils"
import { getInitialParameterValues } from "utils/richParameters"

Expand DownExpand Up@@ -118,7 +119,9 @@ export const BuildParametersPopover = ({
This template has no ephemeral build options.
</HelpTooltipText>
<HelpTooltipLinksGroup>
<HelpTooltipLink href="https://coder.com/docs/v2/latest/templates/parameters#ephemeral-parameters">
<HelpTooltipLink
href={docs("/templates/parameters#ephemeral-parameters")}
>
Read the docs
</HelpTooltipLink>
</HelpTooltipLinksGroup>
Expand Down
3 changes: 2 additions & 1 deletionsite/src/pages/AuditPage/AuditFilter.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
import { UseFilterMenuOptions, useFilterMenu } from "components/Filter/menu"
import { BaseOption } from "components/Filter/options"
import capitalize from "lodash/capitalize"
import { docs } from "utils/docs"

const PRESET_FILTERS = [
{
Expand DownExpand Up@@ -44,7 +45,7 @@ export const AuditFilter = ({
}) => {
return (
<Filter
learnMoreLink="https://coder.com/docs/v2/latest/admin/audit-logs#filtering-logs"
learnMoreLink={docs("/admin/audit-logs#filtering-logs")}
presets={PRESET_FILTERS}
isLoading={menus.user.isInitializing}
filter={filter}
Expand Down
9 changes: 3 additions & 6 deletionssite/src/pages/AuditPage/AuditPaywall.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import { Paywall } from "components/Paywall/Paywall"
import { Stack } from "components/Stack/Stack"
import { FC } from "react"
import { useTranslation } from "react-i18next"
import { docs } from "utils/docs"

export const AuditPaywall: FC = () => {
const { t } = useTranslation("auditLog")
Expand All@@ -15,17 +16,13 @@ export const AuditPaywall: FC = () => {
description={t("paywall.description")}
cta={
<Stack direction="row" alignItems="center">
<Link
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
target="_blank"
rel="noreferrer"
>
<Link href={docs("/admin/upgrade")} target="_blank" rel="noreferrer">
<Button size="small" startIcon={<ArrowRightAltOutlined />}>
{t("paywall.actions.upgrade")}
</Button>
</Link>
<Link
href="https://coder.com/docs/coder-oss/latest/admin/audit-logs"
href={docs("/admin/audit-logs")}
target="_blank"
rel="noreferrer"
>
Expand Down
5 changes: 3 additions & 2 deletionssite/src/pages/CreateTemplatePage/CreateTemplateForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,6 +39,7 @@ import {
import camelCase from "lodash/camelCase"
import capitalize from "lodash/capitalize"
import { VariableInput } from "./VariableInput"
import { docs } from "utils/docs"

const MAX_DESCRIPTION_CHAR_LIMIT = 128
const MAX_TTL_DAYS = 30
Expand DownExpand Up@@ -322,7 +323,7 @@ export const CreateTemplateForm: FC<CreateTemplateFormProps> = ({
) : (
<>
{commonT("licenseFieldTextHelper")}{" "}
<Link href="https://coder.com/docs/v2/latest/enterprise">
<Link href={docs("/enterprise")}>
{commonT("learnMore")}
</Link>
.
Expand DownExpand Up@@ -459,7 +460,7 @@ export const CreateTemplateForm: FC<CreateTemplateFormProps> = ({
</Stack>
<span className={styles.optionHelperText}>
This setting requires an enterprise license for the&nbsp;
<Link href="https://coder.com/docs/v2/latest/admin/rbac">
<Link href={docs("/admin/rbac")}>
&apos;Template RBAC&apos;
</Link>{" "}
feature to customize permissions.
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@ import { Header } from "components/DeploySettingsLayout/Header"
import OptionsTable from "components/DeploySettingsLayout/OptionsTable"
import { Stack } from "components/Stack/Stack"
import { useDeploymentOptions } from "utils/deployOptions"
import { docs } from "utils/docs"

export type GeneralSettingsPageViewProps = {
deploymentOptions: DeploymentOption[]
Expand All@@ -22,7 +23,7 @@ export const GeneralSettingsPageView = ({
<Header
title="General"
description="Information about your Coder deployment."
docsHref="https://coder.com/docs/coder-oss/latest/admin/configure"
docsHref={docs("/admin/configure")}
/>
<Stack spacing={4}>
{Boolean(getDeploymentDAUsError) && (
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import { DeploymentValues, GitAuthConfig } from "api/typesGenerated"
import { Alert } from "components/Alert/Alert"
import { EnterpriseBadge } from "components/DeploySettingsLayout/Badges"
import { Header } from "components/DeploySettingsLayout/Header"
import { docs } from "utils/docs"

export type GitAuthSettingsPageViewProps = {
config: DeploymentValues
Expand All@@ -24,7 +25,7 @@ export const GitAuthSettingsPageView = ({
<Header
title="Git Authentication"
description="Coder integrates with GitHub, GitLab, BitBucket, and Azure Repos to authenticate developers with your Git provider."
docsHref="https://coder.com/docs/coder-oss/latest/admin/git-providers"
docsHref={docs("/admin/git-providers")}
/>

<video
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
deploymentGroupHasParent,
useDeploymentOptions,
} from "utils/deployOptions"
import { docs } from "utils/docs"

export type NetworkSettingsPageViewProps = {
options: DeploymentOption[]
Expand All@@ -24,7 +25,7 @@ export const NetworkSettingsPageView = ({
<Header
title="Network"
description="Configure your deployment connectivity."
docsHref="https://coder.com/docs/coder-oss/latest/networking"
docsHref={docs("/networking")}
/>
<OptionsTable
options={options.filter((o) =>
Expand All@@ -38,7 +39,7 @@ export const NetworkSettingsPageView = ({
title="Port Forwarding"
secondary
description="Port forwarding lets developers securely access processes on their Coder workspace from a local machine."
docsHref="https://coder.com/docs/coder-oss/latest/networking/port-forwarding"
docsHref={docs("/networking/port-forwarding")}
/>

<Badges>
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import {
deploymentGroupHasParent,
useDeploymentOptions,
} from "utils/deployOptions"
import { docs } from "utils/docs"

export type SecuritySettingsPageViewProps = {
options: DeploymentOption[]
Expand DownExpand Up@@ -46,7 +47,7 @@ export const SecuritySettingsPageView = ({
title="Audit Logging"
secondary
description="Allow auditors to monitor user operations in your deployment."
docsHref="https://coder.com/docs/coder-oss/latest/admin/audit-logs"
docsHref={docs("/admin/audit-logs")}
/>

<Badges>
Expand All@@ -60,7 +61,7 @@ export const SecuritySettingsPageView = ({
title="Browser Only Connections"
secondary
description="Block all workspace access via SSH, port forward, and other non-browser connections."
docsHref="https://coder.com/docs/coder-oss/latest/networking#browser-only-connections-enterprise"
docsHref={docs("/networking#browser-only-connections-enterprise")}
/>

<Badges>
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
deploymentGroupHasParent,
useDeploymentOptions,
} from "utils/deployOptions"
import { docs } from "utils/docs"

export type UserAuthSettingsPageViewProps = {
options: DeploymentOption[]
Expand All@@ -28,7 +29,7 @@ export const UserAuthSettingsPageView = ({
title="Login with OpenID Connect"
secondary
description="Set up authentication to login with OpenID Connect."
docsHref="https://coder.com/docs/coder-oss/latest/admin/auth#openid-connect-with-google"
docsHref={docs("/admin/auth#openid-connect-with-google")}
/>

<Badges>
Expand All@@ -51,7 +52,7 @@ export const UserAuthSettingsPageView = ({
title="Login with GitHub"
secondary
description="Set up authentication to login with GitHub."
docsHref="https://coder.com/docs/coder-oss/latest/admin/auth#github"
docsHref={docs("/admin/auth#github")}
/>

<Badges>
Expand Down
5 changes: 3 additions & 2 deletionssite/src/pages/GroupsPage/GroupsPageView.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import { Link as RouterLink, useNavigate } from "react-router-dom"
import { Paywall } from "components/Paywall/Paywall"
import { Group } from "api/typesGenerated"
import { GroupAvatar } from "components/GroupAvatar/GroupAvatar"
import { docs } from "utils/docs"

export type GroupsPageViewProps = {
groups: Group[] | undefined
Expand DownExpand Up@@ -49,7 +50,7 @@ export const GroupsPageView: FC<GroupsPageViewProps> = ({
cta={
<Stack direction="row" alignItems="center">
<Button
href="https://coder.com/docs/coder-oss/latest/enterprise"
href={docs("/enterprise")}
target="_blank"
rel="noreferrer"
startIcon={<ArrowRightAltOutlined />}
Expand All@@ -59,7 +60,7 @@ export const GroupsPageView: FC<GroupsPageViewProps> = ({
</Button>

<Link
href="https://coder.com/docs/coder-oss/latest/admin/groups"
href={docs("/admin/groups")}
target="_blank"
rel="noreferrer"
>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import { pageTitle } from "utils/page"
import { templateACLMachine } from "xServices/template/templateACLXService"
import { useTemplateSettingsContext } from "../TemplateSettingsLayout"
import { TemplatePermissionsPageView } from "./TemplatePermissionsPageView"
import { docs } from "utils/docs"

export const TemplatePermissionsPage: FC<
React.PropsWithChildren<unknown>
Expand All@@ -38,7 +39,7 @@ export const TemplatePermissionsPage: FC<
cta={
<Stack direction="row" alignItems="center">
<Link
href="https://coder.com/docs/coder-oss/latest/admin/upgrade"
href={docs("/admin/upgrade")}
target="_blank"
rel="noreferrer"
>
Expand All@@ -50,7 +51,7 @@ export const TemplatePermissionsPage: FC<
</Button>
</Link>
<Link
href="https://coder.com/docs/coder-oss/latest/admin/rbac"
href={docs("/admin/rbac")}
target="_blank"
rel="noreferrer"
>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import { InactivityDialog } from "./InactivityDialog"
import { useWorkspacesToBeDeleted } from "./useWorkspacesToBeDeleted"
import { TemplateScheduleFormValues, getValidationSchema } from "./formHelpers"
import { TTLHelperText } from "./TTLHelperText"
import { docs } from "utils/docs"

const MS_HOUR_CONVERSION = 3600000
const MS_DAY_CONVERSION = 86400000
Expand DownExpand Up@@ -222,9 +223,7 @@ export const TemplateScheduleForm: FC<TemplateScheduleForm> = ({
) : (
<>
{commonT("licenseFieldTextHelper")}{" "}
<Link href="https://coder.com/docs/v2/latest/enterprise">
{commonT("learnMore")}
</Link>
<Link href={docs("/enterprise")}>{commonT("learnMore")}</Link>
.
</>
),
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp