asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: change report issue link (#10160)

Browse Source
This commit is contained in:
Shahed Nasser
2024-11-19 15:54:16 +02:00
committed by GitHub
parent 156494c646
commit a1738f823c
23 changed files with 40 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/components/Tags/Operation/DescriptionSection/index.tsx
View File

@@ -10,7 +10,6 @@ import MDXContentClient from "@/components/MDXContent/Client"
import { useArea } from "../../../../providers/area"
import { Feedback, Badge, Link, FeatureFlagNotice } from "docs-ui"
import { usePathname } from "next/navigation"
import formatReportLink from "../../../../utils/format-report-link"
import { TagsOperationDescriptionSectionWorkflowBadgeProps } from "./WorkflowBadge"
const TagsOperationDescriptionSectionSecurity =
@@ -82,7 +81,6 @@ const TagsOperationDescriptionSection = ({
section: operation.summary,
}}
pathName={pathname}
reportLink={formatReportLink(area, operation.summary)}
className="!my-2"
vertical={true}
question="Did this API Route run successfully?"

2
www/apps/api-reference/components/Tags/Section/index.tsx
View File

@@ -21,7 +21,6 @@ import SectionDivider from "../../Section/Divider"
import clsx from "clsx"
import { Feedback, Loading, Link } from "docs-ui"
import { usePathname, useRouter } from "next/navigation"
import formatReportLink from "@/utils/format-report-link"
import { PathsObject, SchemaObject, TagObject } from "@/types/openapi"
import { TagSectionSchemaProps } from "./Schema"
import checkElementInViewport from "../../../utils/check-element-in-viewport"
@@ -165,7 +164,6 @@ const TagSectionComponent = ({ tag }: TagSectionProps) => {
section: tag.name,
}}
pathName={pathname}
reportLink={formatReportLink(area, tag.name)}
vertical
question="Was this section helpful?"
/>

7
www/apps/api-reference/markdown/admin.mdx
View File

@@ -6,7 +6,6 @@ import {
DividedMarkdownCode
} from "@/layouts/DividedMarkdown/Sections"
import Section from "@/components/Section"
import formatReportLink from "@/utils/format-report-link"
import ClientLibraries from "./client-libraries.mdx"
@@ -28,7 +27,6 @@ All API Routes are prefixed with `/admin`. So, during development, the API Route
area: "admin",
section: "introduction"
}}
reportLink={formatReportLink("admin", "Introduction")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}
@@ -305,7 +303,6 @@ fetch(`<BACKEND_URL>/admin/products`, {
area: "admin",
section: "authentication-cookie"
}}
reportLink={formatReportLink("admin", "Authentication - Cookie Session ID")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}
@@ -355,7 +352,6 @@ x-no-compression: true
area: "admin",
section: "http-compression"
}}
reportLink={formatReportLink("admin", "Authentication - Cookie Session ID")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}
@@ -687,7 +683,6 @@ curl -g "http://localhost:9000/admin/products?created_at[$lt]=2023-02-17&created
area: "admin",
section: "query-parameters"
}}
reportLink={formatReportLink("admin", "Query Parameter Types")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}
@@ -814,7 +809,6 @@ This sorts the products by their `created_at` field in the descending order.
area: "admin",
section: "pagination"
}}
reportLink={formatReportLink("admin", "Pagination")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}
@@ -846,7 +840,6 @@ Refer to [this guide](https://docs.medusajs.com/customization/extend-models/exte
area: "admin",
section: "workflows"
}}
reportLink={formatReportLink("admin", "Workflows")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}

9
www/apps/api-reference/markdown/store.mdx
View File

@@ -6,7 +6,6 @@ import {
} from "@/layouts/DividedMarkdown/Sections"
import Section from "@/components/Section"
import { Feedback, CodeTabs, CodeTab } from "docs-ui"
import formatReportLink from "@/utils/format-report-link"
import ClientLibraries from "./client-libraries.mdx"
@@ -28,7 +27,6 @@ All API Routes are prefixed with `/store`. So, during development, the API Route
area: "store",
section: "introduction"
}}
reportLink={formatReportLink("store", "Introduction")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -242,7 +240,6 @@ fetch(`<BACKEND_URL>/store/products`, {
area: "store",
section: "authentication-cookie"
}}
reportLink={formatReportLink("store", "Authentication - Cookie Session ID")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -307,7 +304,6 @@ Where `{your_publishable_api_key}` is the token of the publishable API key.
area: "store",
section: "publishable-api-key"
}}
reportLink={formatReportLink("store", "Publishable API Key")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -357,7 +353,6 @@ x-no-compression: true
area: "store",
section: "http-compression"
}}
reportLink={formatReportLink("store", "HTTP Compression")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -481,7 +476,6 @@ This returns the variants of each product, but the variants only have their `id`
area: "store",
section: "select-fields"
}}
reportLink={formatReportLink("store", "Selecting Fields")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -694,7 +688,6 @@ curl -g "http://localhost:9000/store/products?created_at[$lt]=2023-02-17&created
area: "store",
section: "query-parameters"
}}
reportLink={formatReportLink("store", "Query Parameter Types")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -819,7 +812,6 @@ This sorts the products by their `created_at` field in the descending order.
area: "store",
section: "pagination"
}}
reportLink={formatReportLink("store", "Pagination")}
pathName="/api/store"
question="Was this section helpful?"
vertical={true}
@@ -847,7 +839,6 @@ Refer to [this guide](https://docs.medusajs.com/customization/extend-models/exte
area: "admin",
section: "workflows"
}}
reportLink={formatReportLink("admin", "Workflows")}
pathName="/api/admin"
question="Was this section helpful?"
vertical={true}

17
www/apps/api-reference/providers/main-nav.tsx
View File

@@ -1,10 +1,8 @@
"use client"
import {
formatReportLink,
getNavDropdownItems,
MainNavProvider as UiMainNavProvider,
useIsBrowser,
} from "docs-ui"
import { useMemo } from "react"
import { config } from "../config"
@@ -14,7 +12,6 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const { isBrowser } = useIsBrowser()
const navigationDropdownItems = useMemo(
() =>
getNavDropdownItems({
@@ -23,20 +20,8 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[]
)
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
return (
<UiMainNavProvider
navItems={navigationDropdownItems}
reportIssueLink={reportLink}
>
<UiMainNavProvider navItems={navigationDropdownItems}>
{children}
</UiMainNavProvider>
)

5
www/apps/api-reference/utils/format-report-link.ts
View File

@@ -1,5 +0,0 @@
import { formatReportLink as uiFormatReportLink } from "docs-ui"
export default function formatReportLink(area = "admin", sectionTitle: string) {
return uiFormatReportLink(`API Ref(${area})`, sectionTitle)
}

13
www/apps/book/components/Feedback/index.tsx
View File

@@ -3,11 +3,8 @@
import {
Feedback as UiFeedback,
FeedbackProps as UiFeedbackProps,
formatReportLink,
useIsBrowser,
} from "docs-ui"
import { usePathname } from "next/navigation"
import { config } from "../../config"
import { basePathUrl } from "../../utils/base-path-url"
import { useMemo } from "react"
@@ -15,23 +12,13 @@ type FeedbackProps = Omit<UiFeedbackProps, "event" | "pathName">
const Feedback = (props: FeedbackProps) => {
const pathname = usePathname()
const { isBrowser } = useIsBrowser()
const feedbackPathname = useMemo(() => basePathUrl(pathname), [pathname])
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
return (
<UiFeedback
event="survey"
pathName={feedbackPathname}
reportLink={reportLink}
question={props.question || "Was this chapter helpful?"}
{...props}
/>

18
www/apps/book/providers/main-nav.tsx
View File

@@ -1,10 +1,8 @@
"use client"
import {
formatReportLink,
getNavDropdownItems,
MainNavProvider as UiMainNavProvider,
useIsBrowser,
} from "docs-ui"
import { useMemo } from "react"
import { config } from "../config"
@@ -16,7 +14,6 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const { isBrowser } = useIsBrowser()
const pathname = usePathname()
const navigationDropdownItems = useMemo(
() =>
@@ -26,15 +23,6 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[]
)
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
const editDate = useMemo(
() =>
(generatedEditDates as Record<string, string>)[
@@ -44,11 +32,7 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
)
return (
<UiMainNavProvider
navItems={navigationDropdownItems}
reportIssueLink={reportLink}
editDate={editDate}
>
<UiMainNavProvider navItems={navigationDropdownItems} editDate={editDate}>
{children}
</UiMainNavProvider>
)

13
www/apps/resources/components/Feedback/index.tsx
View File

@@ -3,11 +3,8 @@
import {
Feedback as UiFeedback,
FeedbackProps as UiFeedbackProps,
formatReportLink,
useIsBrowser,
} from "docs-ui"
import { usePathname } from "next/navigation"
import { config } from "../../config"
import { useMemo } from "react"
import { basePathUrl } from "../../utils/base-path-url"
@@ -15,23 +12,13 @@ type FeedbackProps = Omit<UiFeedbackProps, "event" | "pathName">
export const Feedback = (props: FeedbackProps) => {
const pathname = usePathname()
const { isBrowser } = useIsBrowser()
const feedbackPathname = useMemo(() => basePathUrl(pathname), [pathname])
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
return (
<UiFeedback
event="survey"
pathName={feedbackPathname}
reportLink={reportLink}
question="Was this page helpful?"
{...props}
/>

18
www/apps/resources/providers/main-nav.tsx
View File

@@ -1,10 +1,8 @@
"use client"
import {
formatReportLink,
getNavDropdownItems,
MainNavProvider as UiMainNavProvider,
useIsBrowser,
} from "docs-ui"
import { useMemo } from "react"
import { config } from "../config"
@@ -16,7 +14,6 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const { isBrowser } = useIsBrowser()
const pathname = usePathname()
const navigationDropdownItems = useMemo(
() =>
@@ -26,15 +23,6 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[]
)
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
const editDate = useMemo(
() =>
(generatedEditDates as Record<string, string>)[
@@ -44,11 +32,7 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
)
return (
<UiMainNavProvider
navItems={navigationDropdownItems}
reportIssueLink={reportLink}
editDate={editDate}
>
<UiMainNavProvider navItems={navigationDropdownItems} editDate={editDate}>
{children}
</UiMainNavProvider>
)

2
www/apps/ui/src/components/feedback.tsx
View File

@@ -3,7 +3,6 @@
import {
Feedback as UiFeedback,
FeedbackProps as UiFeedbackProps,
formatReportLink,
} from "docs-ui"
import { usePathname } from "next/navigation"
import { absoluteUrl } from "@/lib/absolute-url"
@@ -20,7 +19,6 @@ export const Feedback = ({ title, ...props }: FeedbackProps) => {
<UiFeedback
event="survey"
pathName={absoluteUrl(pathname)}
reportLink={formatReportLink("UI Docs", title, "ui")}
extraData={{
section: title,
}}

13
www/apps/ui/src/providers/main-nav.tsx
View File

@@ -1,10 +1,8 @@
"use client"
import {
formatReportLink,
getNavDropdownItems,
MainNavProvider as UiMainNavProvider,
useIsBrowser,
} from "docs-ui"
import { useMemo } from "react"
import { siteConfig } from "../config/site"
@@ -14,7 +12,6 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const { isBrowser } = useIsBrowser()
const navigationDropdownItems = useMemo(
() =>
getNavDropdownItems({
@@ -23,16 +20,8 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[]
)
const reportLink = useMemo(
() => formatReportLink("UI Docs", isBrowser ? document.title : "", "ui"),
[isBrowser]
)
return (
<UiMainNavProvider
navItems={navigationDropdownItems}
reportIssueLink={reportLink}
>
<UiMainNavProvider navItems={navigationDropdownItems}>
{children}
</UiMainNavProvider>
)

13
www/apps/user-guide/components/Feedback/index.tsx
View File

@@ -3,11 +3,8 @@
import {
Feedback as UiFeedback,
FeedbackProps as UiFeedbackProps,
formatReportLink,
useIsBrowser,
} from "docs-ui"
import { usePathname } from "next/navigation"
import { config } from "../../config"
import { basePathUrl } from "../../utils/base-path-url"
import { useMemo } from "react"
@@ -15,23 +12,13 @@ type FeedbackProps = Omit<UiFeedbackProps, "event" | "pathName">
const Feedback = (props: FeedbackProps) => {
const pathname = usePathname()
const { isBrowser } = useIsBrowser()
const feedbackPathname = useMemo(() => basePathUrl(pathname), [pathname])
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
return (
<UiFeedback
event="survey"
pathName={feedbackPathname}
reportLink={reportLink}
question="Was this chapter helpful?"
{...props}
/>

17
www/apps/user-guide/providers/main-nav.tsx
View File

@@ -1,10 +1,8 @@
"use client"
import {
formatReportLink,
getNavDropdownItems,
MainNavProvider as UiMainNavProvider,
useIsBrowser,
} from "docs-ui"
import { useMemo } from "react"
import { config } from "../config"
@@ -14,7 +12,6 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const { isBrowser } = useIsBrowser()
const navigationDropdownItems = useMemo(
() =>
getNavDropdownItems({
@@ -23,20 +20,8 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[]
)
const reportLink = useMemo(
() =>
formatReportLink(
config.titleSuffix || "",
isBrowser ? document.title : ""
),
[isBrowser]
)
return (
<UiMainNavProvider
navItems={navigationDropdownItems}
reportIssueLink={reportLink}
>
<UiMainNavProvider navItems={navigationDropdownItems}>
{children}
</UiMainNavProvider>
)

6
www/packages/docs-ui/src/components/CodeBlock/Actions/index.tsx
View File

@@ -4,7 +4,7 @@ import clsx from "clsx"
import React from "react"
import { Link, Tooltip } from "@/components"
import { ExclamationCircle, PlaySolid } from "@medusajs/icons"
import { GITHUB_ISSUES_PREFIX } from "@/constants"
import { GITHUB_ISSUES_LINK } from "@/constants"
import { CodeBlockCopyAction } from "./Copy"
export type CodeBlockActionsProps = {
@@ -109,9 +109,7 @@ export const CodeBlockActions = ({
)}
>
<Link
href={`${GITHUB_ISSUES_PREFIX}&title=${encodeURIComponent(
`Docs(Code Issue): `
)}`}
href={GITHUB_ISSUES_LINK}
target="_blank"
className={clsx(
"bg-transparent border-none cursor-pointer rounded",

11
www/packages/docs-ui/src/components/Feedback/index.tsx
View File

@@ -1,6 +1,6 @@
"use client"
import React, { useRef, useState } from "react"
import React, { useMemo, useRef, useState } from "react"
// @ts-expect-error can't install the types package because it doesn't support React v19
import { CSSTransition, SwitchTransition } from "react-transition-group"
import { Solutions } from "./Solutions"
@@ -16,6 +16,7 @@ import {
} from "@/components"
import { ChatBubbleLeftRight, ThumbDown, ThumbUp } from "@medusajs/icons"
import Link from "next/link"
import { useSiteConfig } from "../../providers"
export type FeedbackProps = {
event: string
@@ -39,7 +40,7 @@ export type FeedbackProps = {
export const Feedback = ({
event,
pathName,
reportLink,
reportLink: initReportLink,
question = "Was this page helpful?",
positiveBtn = "It was helpful",
negativeBtn = "It wasn't helpful",
@@ -54,6 +55,12 @@ export const Feedback = ({
showLongForm = false,
showDottedSeparator = true,
}: FeedbackProps) => {
const {
config: { reportIssueLink },
} = useSiteConfig()
const reportLink = useMemo(() => {
return initReportLink || reportIssueLink
}, [initReportLink, reportIssueLink])
const [showForm, setShowForm] = useState(false)
const [submittedFeedback, setSubmittedFeedback] = useState(false)
const [loading, setLoading] = useState(false)

4
www/packages/docs-ui/src/components/MainNav/index.tsx
View File

@@ -26,7 +26,7 @@ type MainNavProps = {
}
export const MainNav = ({ className, itemsClassName }: MainNavProps) => {
const { reportIssueLink, editDate } = useMainNav()
const { editDate } = useMainNav()
const { setMobileSidebarOpen, isSidebarShown } = useSidebar()
const { config } = useSiteConfig()
@@ -64,7 +64,7 @@ export const MainNav = ({ className, itemsClassName }: MainNavProps) => {
<MainNavVersion />
{editDate && <MainNavEditDate date={editDate} />}
<LinkButton
href={reportIssueLink}
href={config.reportIssueLink || ""}
variant="subtle"
target="_blank"
className="text-compact-small-plus"

4
www/packages/docs-ui/src/constants.tsx
View File

@@ -1,8 +1,8 @@
import { OptionType } from "@/hooks"
import { NavigationItem } from "types"
export const GITHUB_ISSUES_PREFIX = `https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml`
export const GITHUB_UI_ISSUES_PREFIX = `https://github.com/medusajs/ui/issues/new?labels=documentation`
export const GITHUB_ISSUES_LINK =
"https://github.com/medusajs/medusa/issues/new/choose"
export const navDropdownItems: NavigationItem[] = [
{

4
www/packages/docs-ui/src/providers/MainNav/index.tsx
View File

@@ -9,7 +9,6 @@ export type MainNavContext = {
navItems: NavigationItem[]
activeItemIndex?: number
activeItem?: NavigationItem
reportIssueLink: string
editDate?: string
}
@@ -17,14 +16,12 @@ const MainNavContext = createContext<MainNavContext | null>(null)
export type MainNavProviderProps = {
navItems: NavigationItem[]
reportIssueLink: string
editDate?: string
children?: React.ReactNode
}
export const MainNavProvider = ({
navItems,
reportIssueLink,
children,
editDate,
}: MainNavProviderProps) => {
@@ -90,7 +87,6 @@ export const MainNavProvider = ({
value={{
navItems,
activeItemIndex,
reportIssueLink,
editDate,
activeItem,
}}

33
www/packages/docs-ui/src/providers/SiteConifg/index.tsx
View File

@@ -3,6 +3,7 @@
import React, { createContext, useContext, useState } from "react"
import { DocsConfig } from "types"
import { globalConfig } from "../../global-config"
import { GITHUB_ISSUES_LINK } from "../.."
export type SiteConfigContextType = {
config: DocsConfig
@@ -21,21 +22,25 @@ export const SiteConfigProvider = ({
children,
}: SiteConfigProviderProps) => {
const [config, setConfig] = useState<DocsConfig>(
initConfig || {
baseUrl: "",
sidebar: {
default: [],
mobile: [],
Object.assign(
{
baseUrl: "",
sidebar: {
default: [],
mobile: [],
},
project: {
title: "",
key: "",
},
breadcrumbOptions: {
showCategories: true,
},
reportIssueLink: GITHUB_ISSUES_LINK,
},
project: {
title: "",
key: "",
},
breadcrumbOptions: {
showCategories: true,
},
...globalConfig,
}
globalConfig,
initConfig || {}
)
)
return (

17
www/packages/docs-ui/src/utils/format-report-link.ts
View File

@@ -1,17 +0,0 @@
import { GITHUB_ISSUES_PREFIX, GITHUB_UI_ISSUES_PREFIX } from "../constants"
export type ReportLinkType = "default" | "ui"
export function formatReportLink(
title: string,
sectionTitle: string,
type?: ReportLinkType
) {
let prefix = GITHUB_ISSUES_PREFIX
if (type === "ui") {
prefix = GITHUB_UI_ISSUES_PREFIX
}
return `${prefix}&title=${encodeURI(title)}%3A%20Issue%20in%20${encodeURI(
sectionTitle
)}`
}

1
www/packages/docs-ui/src/utils/index.ts
View File

@@ -3,7 +3,6 @@ export * from "./capitalize"
export * from "./check-sidebar-item-visibility"
export * from "./decode-str"
export * from "./dom-utils"
export * from "./format-report-link"
export * from "./get-link-with-base-path"
export * from "./get-navbar-items"
export * from "./get-os-shortcut"

1
www/packages/types/src/config.ts
View File

@@ -20,4 +20,5 @@ export declare type DocsConfig = {
number: string
releaseUrl: string
}
reportIssueLink?: string
}