README-CN.md

English README

TapData 用户手册

欢迎访问 TapData 文档仓库，本仓库存储了 TapData 用户手册的源文件（Markdown 格式），前往 TapData 文档中心：https://docs.tapdata.io

如您发现 TapData 文档问题，欢迎提交 Issue 告诉我们，我们会尽快修复，您也可以直接提交 PR 来修改。

什么是 TapData?

TapData 是一款面向数据服务的平台化产品，旨在帮助企业打破多个数据孤岛，完成数据快速交付，同时依靠实时数据同步，提高数据传输效率。

🎮 开始免费使用

如何贡献

我们非常欢迎更多贡献者来帮助改进文档，TapData 文档使用 Markdown 语言编写，下面是提交 PR 的流程，如果您对这些操作比较陌生，欢迎联系我们获得帮助。

1. 克隆本仓库至本地。

   git clone https://github.com/tapdata/docs.git

2. 安装相关依赖。

   执行下述命令前需要 Node.js v16.14 或以上版本（可运行 node -v 查看版本号）。

   cd docs
   npm install
   # or 
   yarn install

3. 修改或新增文档。

4. 在本地环境运行网页服务并预览您的更改，地址为 http://localhost:3000/。

   npm run start

5. 检查并修复断链或无效锚点。

   # 生成网站静态网页
   npm run build
   # 执行检查，基于界面提示修复
   npx @untitaker/hyperlink ./build --check-anchors

6. 确认无问题后，提交 PR。

目录结构说明

├── docs                      # 存放当前版本的文档
│   ├── cloud                 # TapData Cloud 文档
│   │   ├── images            # 统一存放屏幕截图、架构图等，供文档引用
│   │   ├── …………
│   ├── enterprise            # TapData 文档
│   │   ├── images            
│   │   ├── …………
│   └── reuse-content         # 可复用内容，我们可以在 Markdown 文件中引用该目录中的文件
├── docusaurus.config.js      # 网站配置文件
├── sidebars.js               # 当前版本手册的目录
├── src                       # 非文档文件，例如自定义 CSS 文件
│   ├── components
│   ├── css
│   └── pages
├── static                    # 静态目录，该目录中的文件会被复制至 build 目录中，可以在这里提供网站 Logo 或下载资源
│   └── img
├── versioned_docs            # 存放分版文档
│   └── version-2.0           # 存放 2.0 版本的文档
│       ├── cloud
│       ├── enterprise
│       └── reuse-content
├── versioned_sidebars        # 2.0 版本手册的目录
└── versions.json             # 手册可用的版本信息

联系我们

• Slack 频道

• Twitter @tapdata_daas

• 加入技术社区

  

  ​ ​ ​ ​ ​ ​