Skip to content

Commit 7d53169

Browse files
Chasen-ZhangChasen-Zhang
authored
feat: refactor overview (#1091)
1 parent 4b96879 commit 7d53169

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+981
-33
lines changed

‎docs/cn/guides/00-overview/index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@ title: 概览
33
slug: /
44
---
55

6+
import DocsOverview from '@site/src/components/DocsOverview'
7+
68
欢迎阅读 Databend（发音为 /ˈdeɪtəˌbɛnd/）指南，涵盖 Databend 版本的各个方面。
79

8-
## 术语表
10+
**术语表**
911

10-
- **`Databend`** 指 [开源版本](https://github.com/datafuselabs/databend)。
11-
- **`Databend Cloud`** 是一个完全 [托管的云服务](https://databend.com)。
12-
- **`Databend(Cloud)`** 统指 `Databend` 和 `Databend Cloud`。
12+
- **`Databend`** 指 [开源版本](https://github.com/datafuselabs/databend).
13+
- **`Databend Cloud`** 是一个完全 [托管的云服务](https://databend.cn).
14+
- **`Databend(Cloud)`** 统指 `Databend` 和 `Databend Cloud`.
1315

14-
## 入门指南
16+
<DocsOverview />
17+
**这里有一些你可能想要了解的入口**
1518

16-
- **[自托管 Databend](../10-deploy/index.md)**: 关于部署、升级和监控自托管 Databend 的指南。
17-
- **[Databend Cloud](../20-cloud/index.md)**: 快速开始使用 Databend Cloud。
18-
- **[连接](../30-sql-clients/index.md)**: 使用各种驱动程序连接到 Databend(Cloud)。
19-
- **[数据加载](../40-load-data/index.md)**: 以多种格式批量导入数据到 Databend(Cloud)。
20-
- **[数据卸载](../50-unload-data/index.md)**: 从 Databend(Cloud) 导出数据。
21-
- **[实时 CDC 摄取](../40-load-data/05-continuous-data-pipelines/01-stream.md)**: 变更数据捕获 (CDC) 实现实时数据摄取。
22-
- **[自动化数据管道](../40-load-data/05-continuous-data-pipelines/02-task.md)**: 创建任务以自动化和管理持续数据管道。
23-
- **[外部函数](../54-query/04-external-function.md)**: 使用外部函数扩展 Databend 的功能。
24-
- **[数据管理](../57-data-management/index.md)**: 管理 Databend(Cloud) 中的数据。
25-
- **[安全性](../56-security/index.md)**: Databend(Cloud) 中的安全特性。
26-
- **[可视化](../31-visualize/index.md)**: 使用可视化工具与 Databend(Cloud) 配合。
27-
- **[基准测试](../80-benchmark/index.md)**: 在 TPC-H SF100 基准测试中比较 Databend Cloud 与 Snowflake 的性能。
19+
- **[SQL Reference](/sql)**: your swift-access guide for Databend essentials!
20+
- **[Data Unloading](../50-unload-data/index.md)**: Export data from Databend(Cloud).
21+
- **[External Functions](../54-query/04-external-function.md)**: Use external functions to extend Databend's capabilities.
22+
- **[Data Management](../57-data-management/index.md)**: Manage data in Databend(Cloud).
23+
- **[Security](../56-security/index.md)**: Security features in Databend(Cloud).
24+
- **[Benchmarks](../80-benchmark/index.md)**: Compare Databend Cloud performance with Snowflake on TPC-H SF100 benchmarks.
25+
- **[Accessing Data Lake](../51-access-data-lake/index.md)**: Databend presents a seamless integration with three robust Data Lake technologies—Apache Hive, Apache Iceberg, and Delta Lake.
26+
- **[Query Structures](../54-query/index.md)**: Databend supports diverse query structures to enhance your data querying experience
27+
- **[Performance Optimization](../55-performance/index.md)**: Databend supports the following features to optimize query performance across various scenarios

‎docs/en/guides/00-overview/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@ title: Overview
33
slug: /
44
---
55

6+
import DocsOverview from '@site/src/components/DocsOverview'
7+
68
Welcome to the Databend (pronounced as /ˈdeɪtəˌbɛnd/) Guides, covering all aspects of Databend Editions.
79

8-
## Glossary
10+
**Glossary**
911

1012
- **`Databend`** refers to the [open-source version](https://github.com/datafuselabs/databend).
1113
- **`Databend Cloud`** is a fully [managed cloud service](https://databend.com).
1214
- **`Databend(Cloud)`** collectively denotes both `Databend` and `Databend Cloud`.
1315

14-
## Getting Started
16+
<DocsOverview />
17+
**Here are some entries you might want to learn about**
1518

16-
- **[Self-Hosted Databend](../10-deploy/index.md)**: Guides for deploying, upgrading, and monitoring a self-hosted Databend.
17-
- **[Databend Cloud](../20-cloud/index.md)**: Start quickly with Databend Cloud.
18-
- **[Connect](../30-sql-clients/index.md)**: Connecting to Databend(Cloud) using various drivers.
19-
- **[Data Loading](../40-load-data/index.md)**: Bulk import data into Databend(Cloud) in multiple formats.
19+
- **[SQL Reference](/sql)**: your swift-access guide for Databend essentials!
2020
- **[Data Unloading](../50-unload-data/index.md)**: Export data from Databend(Cloud).
21-
- **[Real-Time CDC Ingestion](../40-load-data/05-continuous-data-pipelines/01-stream.md)**: Change Data Capture (CDC) for real-time data ingestion.
22-
- **[Automated Data Pipelines](../40-load-data/05-continuous-data-pipelines/02-task.md)**: Create tasks to automate and manage continuous data pipelines.
2321
- **[External Functions](../54-query/04-external-function.md)**: Use external functions to extend Databend's capabilities.
2422
- **[Data Management](../57-data-management/index.md)**: Manage data in Databend(Cloud).
2523
- **[Security](../56-security/index.md)**: Security features in Databend(Cloud).
26-
- **[Visualization](../31-visualize/index.md)**: Use visualization tools with Databend(Cloud).
2724
- **[Benchmarks](../80-benchmark/index.md)**: Compare Databend Cloud performance with Snowflake on TPC-H SF100 benchmarks.
25+
- **[Accessing Data Lake](../51-access-data-lake/index.md)**: Databend presents a seamless integration with three robust Data Lake technologies—Apache Hive, Apache Iceberg, and Delta Lake.
26+
- **[Query Structures](../54-query/index.md)**: Databend supports diverse query structures to enhance your data querying experience
27+
- **[Performance Optimization](../55-performance/index.md)**: Databend supports the following features to optimize query performance across various scenarios

‎i18n/en/code.json

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,7 @@
396396
"Thanks for voting!": {
397397
"message": "Thanks for voting!",
398398
"description": "Thanks for voting!"
399-
}
400-
,
399+
},
401400
"Did this page help you?": {
402401
"message": "Did this page help you?",
403402
"description": "Did this page help you?"
@@ -481,5 +480,105 @@
481480
"Blog": {
482481
"message": "Blog",
483482
"description": "Blog"
483+
},
484+
"Learn how to use Databend through guides, reference documentation.": {
485+
"message": "Learn how to use Databend through guides, reference documentation.",
486+
"description": "Description for learning how to use Databend"
487+
},
488+
"Quick Start": {
489+
"message": "Quick Start",
490+
"description": "Title for Quick Start section"
491+
},
492+
"Get started with Databend in 5 minutes": {
493+
"message": "Get started with Databend in 5 minutes",
494+
"description": "Description for Quick Start section"
495+
},
496+
"Self-Hosted Databend": {
497+
"message": "Self-Hosted",
498+
"description": "Title for Self-Hosted Databend section"
499+
},
500+
"These guides for deploying Databend": {
501+
"message": "These guides for deploying Databend",
502+
"description": "Description for Self-Hosted Databend section"
503+
},
504+
"The fastest way to get started with Databend": {
505+
"message": "The fastest way to get started with Databend",
506+
"description": "Description for Databend Cloud section"
507+
},
508+
"Connect to Databend": {
509+
"message": "Connect to Databend",
510+
"description": "Title for Connect to Databend section"
511+
},
512+
"Developer Resources": {
513+
"message": "Developer Resources",
514+
"description": "Link text for Developer Resources"
515+
},
516+
"Connect your application to Databend in just a few minutes.": {
517+
"message": "Connect your application to Databend in just a few minutes.",
518+
"description": "Description for Connect to Databend section"
519+
},
520+
"Load Data into Databend": {
521+
"message": "Load Data into Databend",
522+
"description": "Title for Load Data into Databend section"
523+
},
524+
"Know More": {
525+
"message": "Know More",
526+
"description": "Link text for Know More"
527+
},
528+
"Bulk import data into Databend(Cloud) in multiple formats.": {
529+
"message": "Bulk import data into Databend(Cloud) in multiple formats.",
530+
"description": "Description for Load Data into Databend section"
531+
},
532+
"AI & BI & Visualization & Notebooks": {
533+
"message": "AI & BI & Visualization & Notebooks",
534+
"description": "Title for AI & BI & Visualization & Notebooks section"
535+
},
536+
"All Tools": {
537+
"message": "All Tools",
538+
"description": "Link text for All Tools"
539+
},
540+
"Databend offers connectors and plugins for integrating with major data import tools, ensuring efficient data synchronization.": {
541+
"message": "Databend offers connectors and plugins for integrating with major data import tools, ensuring efficient data synchronization.",
542+
"description": "Description for AI & BI & Visualization & Notebooks section"
543+
},
544+
"Continuous Data Pipelines": {
545+
"message": "Continuous Data Pipelines",
546+
"description": "Title for Continuous Data Pipelines section"
547+
},
548+
"Data pipelines automate the process of moving and changing data from different sources into Databend.": {
549+
"message": "Data pipelines automate the process of moving and changing data from different sources into Databend.",
550+
"description": "Description for Continuous Data Pipelines section"
551+
},
552+
"Real-Time CDC Ingestion": {
553+
"message": "Real-Time CDC Ingestion",
554+
"description": "Text for Real-Time CDC Ingestion"
555+
},
556+
"Automated Data Pipelines": {
557+
"message": "Automated Data Pipelines",
558+
"description": "Text for Automated Data Pipelines"
559+
},
560+
"Additional Informations": {
561+
"message": "Additional Informations",
562+
"description": "Title for Additional Informations section"
563+
},
564+
"AI Capabilities": {
565+
"message": "AI Capabilities",
566+
"description": "Text for AI Capabilities"
567+
},
568+
"Databend Products": {
569+
"message": "Databend Products",
570+
"description": "Text for Databend Products"
571+
},
572+
"Security": {
573+
"message": "Security",
574+
"description": "Text for Security"
575+
},
576+
"Contact Support": {
577+
"message": "Contact Support",
578+
"description": "Text for Contact Support"
579+
},
580+
"Pricing": {
581+
"message": "Pricing",
582+
"description": "Text for Pricing"
484583
}
485584
}

‎i18n/zh/code.json

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,7 @@
412412
"Thanks for voting!": {
413413
"message": "感谢您的反馈！",
414414
"description": "Thanks for voting!"
415-
}
416-
,
415+
},
417416
"Did this page help you?": {
418417
"message": "这篇文章对您有帮助吗？",
419418
"description": "Did this page help you?"
@@ -497,5 +496,105 @@
497496
"Blog": {
498497
"message": "博客",
499498
"description": "Blog"
499+
},
500+
"Learn how to use Databend through guides, reference documentation.": {
501+
"message": "通过指南和参考文档学习如何使用 Databend。",
502+
"description": "学习如何使用 Databend 的描述"
503+
},
504+
"Quick Start": {
505+
"message": "快速入门",
506+
"description": "快速入门部分的标题"
507+
},
508+
"Get started with Databend in 5 minutes": {
509+
"message": "5 分钟内开始使用 Databend",
510+
"description": "快速入门部分的描述"
511+
},
512+
"Self-Hosted Databend": {
513+
"message": "私有化部署",
514+
"description": "自托管 Databend 部分的标题"
515+
},
516+
"These guides for deploying Databend": {
517+
"message": "这些指南用于部署 Databend",
518+
"description": "自托管 Databend 部分的描述"
519+
},
520+
"The fastest way to get started with Databend": {
521+
"message": "开始使用 Databend 的最快方式",
522+
"description": "Databend Cloud 部分的描述"
523+
},
524+
"Connect to Databend": {
525+
"message": "连接到 Databend",
526+
"description": "连接到 Databend 部分的标题"
527+
},
528+
"Developer Resources": {
529+
"message": "开发者资源",
530+
"description": "开发者资源的链接文字"
531+
},
532+
"Connect your application to Databend in just a few minutes.": {
533+
"message": "几分钟内将您的应用程序连接到 Databend。",
534+
"description": "连接到 Databend 部分的描述"
535+
},
536+
"Load Data into Databend": {
537+
"message": "加载数据到 Databend",
538+
"description": "加载数据到 Databend 部分的标题"
539+
},
540+
"Know More": {
541+
"message": "了解更多",
542+
"description": "了解更多的链接文字"
543+
},
544+
"Bulk import data into Databend(Cloud) in multiple formats.": {
545+
"message": "以多种格式批量导入数据到 Databend（云）。",
546+
"description": "加载数据到 Databend 部分的描述"
547+
},
548+
"AI & BI & Visualization & Notebooks": {
549+
"message": "AI & BI & 可视化 & 笔记本",
550+
"description": "AI & BI & 可视化 & 笔记本 部分的标题"
551+
},
552+
"All Tools": {
553+
"message": "所有工具",
554+
"description": "所有工具的链接文字"
555+
},
556+
"Databend offers connectors and plugins for integrating with major data import tools, ensuring efficient data synchronization.": {
557+
"message": "Databend 提供连接器和插件，用于与主要数据导入工具集成，确保高效的数据同步。",
558+
"description": "AI & BI & 可视化 & 笔记本 部分的描述"
559+
},
560+
"Continuous Data Pipelines": {
561+
"message": "连续数据管道",
562+
"description": "连续数据管道部分的标题"
563+
},
564+
"Data pipelines automate the process of moving and changing data from different sources into Databend.": {
565+
"message": "数据管道自动化地将来自不同来源的数据移动和更改到 Databend 中。",
566+
"description": "连续数据管道部分的描述"
567+
},
568+
"Real-Time CDC Ingestion": {
569+
"message": "实时 CDC 导入",
570+
"description": "实时 CDC 导入的文本"
571+
},
572+
"Automated Data Pipelines": {
573+
"message": "自动化数据管道",
574+
"description": "自动化数据管道的文本"
575+
},
576+
"Additional Informations": {
577+
"message": "额外信息",
578+
"description": "额外信息部分的标题"
579+
},
580+
"AI Capabilities": {
581+
"message": "AI 功能",
582+
"description": "AI 功能的文本"
583+
},
584+
"Databend Products": {
585+
"message": "Databend 的产品",
586+
"description": "Databend 产品的文本"
587+
},
588+
"Security": {
589+
"message": "安全",
590+
"description": "安全的文本"
591+
},
592+
"Contact Support": {
593+
"message": "联系客服",
594+
"description": "联系支持的文本"
595+
},
596+
"Pricing": {
597+
"message": "价格相关",
598+
"description": "价格的文本"
500599
}
501600
}

‎package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"axios": "^1.7.2",
3535
"clsx": "^2.0.0",
3636
"copyforjs": "^1.0.6",
37+
"databend-logos": "^0.0.16",
3738
"docusaurus-plugin-devserver": "^1.0.6",
3839
"docusaurus-plugin-sass": "^0.2.5",
3940
"prism-react-renderer": "^2.3.0",

‎src/components/BaseComponents/ButtonWithIcon/index.tsx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Copyright 2024 DatabendLabs.
2+
import { FC, ReactElement, ReactNode } from "react";
3+
import styles from "./styles.module.scss";
4+
interface IProps {
5+
children: ReactNode | ReactNode[];
6+
width?: number;
7+
}
8+
const ButtonWithIcon: FC<IProps> = ({ children, width = 48 }): ReactElement => {
9+
return (
10+
<div
11+
className={styles.wrap}
12+
style={{ width: width + "px", height: width + "px" }}
13+
>
14+
{children}
15+
</div>
16+
);
17+
};
18+
export default ButtonWithIcon;

‎src/components/BaseComponents/ButtonWithIcon/styles.module.scss

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.wrap {
2+
display: flex;
3+
justify-content: center;
4+
align-items: center;
5+
border: 1px solid var(--color-border);
6+
border-radius: 4px;
7+
}

‎src/components/DocsOverview/content-card-wrap.tsx

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Copyright 2024 DatabendLabs.
2+
import { FC, ReactElement, ReactNode } from "react";
3+
import styles from "./styles.module.scss";
4+
import Title from "./title";
5+
import clsx from "clsx";
6+
interface IProps {
7+
children: ReactNode | ReactNode[];
8+
isNeedLogo?: boolean;
9+
title?: string;
10+
description?: string;
11+
link?: {
12+
to: string;
13+
text: string;
14+
};
15+
className?: string;
16+
}
17+
const ContentCardWrap: FC<IProps> = ({
18+
children,
19+
isNeedLogo = false,
20+
title = "",
21+
description,
22+
link,
23+
className,
24+
}): ReactElement => {
25+
return (
26+
<div className={clsx(styles.cardWrap, className)}>
27+
<Title
28+
isNeedLogo={isNeedLogo}
29+
title={title}
30+
description={description}
31+
link={link}
32+
></Title>
33+
<div className={styles.content} style={{ flex: 1 }}>
34+
{children}
35+
</div>
36+
</div>
37+
);
38+
};
39+
export default ContentCardWrap;

0 commit comments

Comments
 (0)