Skip to content
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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Improve web performance and accessibility #259

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Improve web performance and accessibility #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
434de4e
improve accessibility
harsh-vador Mar 28, 2024
1f2deea
Merge branch 'main' into web-performance
harsh-vador Mar 28, 2024
d3fc9f1
improve accessibility
harsh-vador Mar 28, 2024
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
14 changes: 7 additions & 7 deletions components/ConnectorsInfo/ConnectorsInfo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import classNames from "classnames";
import { uniqBy } from "lodash";
import {uniqBy} from "lodash";
import dynamic from "next/dynamic";
import Link from "next/link";
import { useState } from "react";
import { useDocVersionContext } from "../../context/DocVersionContext";
import {useState} from "react";
import {useDocVersionContext} from "../../context/DocVersionContext";
import {
getConnectorURL,
getSortedServiceList,
} from "../../utils/ConnectorsUtils";
import Loader from "../common/Loader/Loader";
import { CONNECTORS } from "./ConnectorsInfo.constants";
import { ConnectorCategory } from "./ConnectorsInfo.interface";
import {CONNECTORS} from "./ConnectorsInfo.constants";
import {ConnectorCategory} from "./ConnectorsInfo.interface";
import styles from "./ConnectorsInfo.module.css";

const ConnectorImage = dynamic(() => import("./ConnectorImage"), {
Expand All @@ -26,7 +26,7 @@ CONNECTORS.unshift({
});

export default function ConnectorsInfo() {
const { docVersion } = useDocVersionContext();
const {docVersion} = useDocVersionContext();
const [selectedTab, setSelectedTab] = useState<ConnectorCategory>(
CONNECTORS[0]
);
Expand Down Expand Up @@ -60,7 +60,7 @@ export default function ConnectorsInfo() {
<ConnectorImage
className={styles.ConnectorImg}
src={connector.icon}
alt={connector.name}
alt={`${connector.name}-icon`}
/>
<p>{connector.name}</p>
</Link>
Expand Down
7 changes: 6 additions & 1 deletion components/Footer/Footer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ export default function Footer() {
</nav>
<section className={styles.SocialNetworks}>
{footerIconItemsData.map((item) => (
<Link href={item.href} key={item.href} target="_blank">
<Link
href={item.href}
key={item.href}
target="_blank"
aria-label={item.href}
>
{item.icon}
</Link>
))}
Expand Down
44 changes: 24 additions & 20 deletions components/TopNav/TopNav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
import algoliasearch from "algoliasearch/lite";
import classNames from "classnames";
import { isEmpty, isString } from "lodash";
import {isEmpty, isString} from "lodash";
import Link from "next/link";
import { useRouter } from "next/router";
import { useCallback, useEffect, useState } from "react";
import { MdMenu, MdMenuOpen } from "react-icons/md";
import { InstantSearch } from "react-instantsearch";
import {useRouter} from "next/router";
import {useCallback, useEffect, useState} from "react";
import {MdMenu, MdMenuOpen} from "react-icons/md";
import {InstantSearch} from "react-instantsearch";
import {
DEFAULT_VERSION,
REGEX_VERSION_MATCH,
REGEX_VERSION_MATCH_WITH_SLASH_AT_START,
} from "../../constants/version.constants";
import { useDocVersionContext } from "../../context/DocVersionContext";
import { useNavBarCollapsedContext } from "../../context/NavBarCollapseContext";
import { SearchContextProvider } from "../../context/SearchContext";
import { ReactComponent as ApiIcon } from "../../images/icons/api.svg";
import { ReactComponent as CloudIcon } from "../../images/icons/cloud.svg";
import { ReactComponent as GithubIcon } from "../../images/icons/github.svg";
import { ReactComponent as OMDIcon } from "../../images/icons/omd.svg";
import { ReactComponent as SlackIcon } from "../../images/icons/slack.svg";
import { getUrlWithVersion } from "../../utils/CommonUtils";
import {useDocVersionContext} from "../../context/DocVersionContext";
import {useNavBarCollapsedContext} from "../../context/NavBarCollapseContext";
import {SearchContextProvider} from "../../context/SearchContext";
import {ReactComponent as ApiIcon} from "../../images/icons/api.svg";
import {ReactComponent as CloudIcon} from "../../images/icons/cloud.svg";
import {ReactComponent as GithubIcon} from "../../images/icons/github.svg";
import {ReactComponent as OMDIcon} from "../../images/icons/omd.svg";
import {ReactComponent as SlackIcon} from "../../images/icons/slack.svg";
import {getUrlWithVersion} from "../../utils/CommonUtils";
import Search from "../Search/Search";
import SelectDropdown, { SelectOption } from "../SelectDropdown/SelectDropdown";
import SelectDropdown, {SelectOption} from "../SelectDropdown/SelectDropdown";
import styles from "./TopNav.module.css";

const searchClient = algoliasearch(
Expand All @@ -33,12 +33,12 @@ interface TopNavProps {
versionsList: Array<SelectOption<string>>;
}

export default function TopNav({ versionsList }: Readonly<TopNavProps>) {
export default function TopNav({versionsList}: Readonly<TopNavProps>) {
const router = useRouter();
const [displayNavBarCollapseButton, setDisplayNavBarCollapseButton] =
useState(false);
const { docVersion, onChangeDocVersion } = useDocVersionContext();
const { navBarCollapsed, onChangeNavBarCollapsed } =
const {docVersion, onChangeDocVersion} = useDocVersionContext();
const {navBarCollapsed, onChangeNavBarCollapsed} =
useNavBarCollapsedContext();

const handleVersionChange = (value: string) => {
Expand Down Expand Up @@ -87,7 +87,10 @@ export default function TopNav({ versionsList }: Readonly<TopNavProps>) {
>
<div className={styles.CollapsedDivContainer}>
<div className={styles.LogoContainer}>
<Link href={docVersion ? getUrlWithVersion("/", docVersion) : "/"}>
<Link
href={docVersion ? getUrlWithVersion("/", docVersion) : "/"}
aria-label="omd-icon"
>
<OMDIcon />
</Link>
{!isEmpty(versionsList) && (
Expand Down Expand Up @@ -136,8 +139,9 @@ export default function TopNav({ versionsList }: Readonly<TopNavProps>) {
className="btn fw-500 btn-primary rounded-pill"
href="https://cloud.getcollate.io"
target="_blank"
aria-label="cloud-icon"
>
<button className={styles.CloudBtn}>
<button className={styles.CloudBtn} aria-label="cloud-icon">
<CloudIcon />
</button>
</a>
Expand Down
19 changes: 10 additions & 9 deletions pages/_app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ import "prismjs";
import "../public/globals.css";
import "../public/modal.css";

import type { MarkdocNextJsPageProps } from "@markdoc/next.js";
import type { AppProps } from "next/app";
import type {MarkdocNextJsPageProps} from "@markdoc/next.js";
import type {AppProps} from "next/app";
import ErrorBoundary from "../components/ErrorBoundary";
import { CodeWithLanguageSelectorContextProvider } from "../context/CodeWithLanguageSelectorContext";
import { DocVersionContextProvider } from "../context/DocVersionContext";
import { MenuItemsContextProvider } from "../context/MenuItemsContext";
import { NavBarCollapseContextProvider } from "../context/NavBarCollapseContext";
import { RouteChangingContextProvider } from "../context/RouteChangingContext";
import { StepsContextProvider } from "../context/StepsContext";
import {CodeWithLanguageSelectorContextProvider} from "../context/CodeWithLanguageSelectorContext";
import {DocVersionContextProvider} from "../context/DocVersionContext";
import {MenuItemsContextProvider} from "../context/MenuItemsContext";
import {NavBarCollapseContextProvider} from "../context/NavBarCollapseContext";
import {RouteChangingContextProvider} from "../context/RouteChangingContext";
import {StepsContextProvider} from "../context/StepsContext";

const TITLE = "OpenMetadata Documentation: Get Help Instantly";
const DESCRIPTION =
"Follow the step-by-step guides to get started with OpenMetadata, the #1 open source data catalog tool. Get discovery, collaboration, governance, observability, quality tools all in one place.";

export type MyAppProps = MarkdocNextJsPageProps;

export default function MyApp({ Component, pageProps }: AppProps<MyAppProps>) {
export default function MyApp({Component, pageProps}: AppProps<MyAppProps>) {
return (
<>
<Head>
<html lang="en" />
<title>{TITLE}</title>
<link rel="icon" href="/favicon.png" />
<link rel="alternate icon" href="/favicon.png" />
Expand Down