Apache CarbonData 官方网站技术文档

本文档旨在帮助用户安装、使用和深入了解 Apache CarbonData 官方网站项目。以下是项目的安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

环境要求

CarbonData 官方网站使用 docsite 构建。

请确保您的 node 版本为 10+，低于 10.x 版本的 node 暂不支持。

安装步骤

1. 在项目根目录下运行 npm install 命令安装依赖。
2. 如果您想调试中文网站，可以在项目根目录下运行 npm run start 命令启动本地服务器，然后在浏览器中访问 http://127.0.0.1:8080 查看网站。
3. 运行 npm run build 命令将源代码构建到 dist 目录。
4. 如果您想查看完整的网站，可以全局安装 http-server，然后在项目根目录下运行 http-server ./dist。

如果您已安装了更高版本的 node，可以使用 nvm 管理不同版本的 node。

1. 按照官方 安装指南 安装 nvm。
2. 运行 nvm install v10.23.1 命令安装 node v10。
3. 运行 nvm use v10.23.1 命令将工作环境切换到 node v10。

然后您可以按照上述构建指南进行操作。

2. 项目使用说明

网站更新

1. 编辑 markdown 文件。
2. 提交并推送到 github。
3. 网站将通过 github action 自动更新。

提交 PR

1. 不要使用 git add . 提交所有更改。
2. 只推送您更改的文件，例如：
   • *.md
   • blog.js 或 docs.js 或 site.js
3. 向 master 分支发送 PR。

SEO

确保每个 .md 文件的开头包含以下内容：

---
title: 标题
keywords: 关键词1,关键词2, 关键词3
description: 描述信息
---

添加新文档

添加新博客

1. 在 blog/zh-cn 或 blog/zh-cn 目录下添加新的 .md 文件。
2. 更新 site_config/blog.js 文件，在 zh-cn 或 zh-cn 中添加新的博客条目。
3. 在本地运行 docsite start 命令，验证博客是否显示正确。
4. 发送包含 .md 和 blog.js 的 PR。

添加开发文档

1. 在 docs/zh-cn/development 或 docs/zh-cn/development 目录下添加新的 .md 文件。
2. 更新 site_config/development.js 文件，在 zh-cn 或 zh-cn 中添加新的文档条目。
3. 在本地运行 docsite start 命令，验证文档是否显示正确。
4. 发送包含 .md 和 development.js 的 PR。

添加文档

1. 在 docs/zh-cn 或 docs/zh-cn 目录下添加新的 .md 文件。
2. 更新 site_config/docs.js 文件，在 zh-cn 或 zh-cn 中添加新的文档条目。
3. 在本地运行 docsite start 命令，验证文档是否显示正确。
4. 发送包含 .md 和 docs.js 的 PR。

3. 项目 API 使用文档

本文档暂时不提供 API 使用文档，如有需要，请参考项目官方文档或源代码。

4. 项目安装方式

请参考本文档的“安装指南”部分进行项目安装。

感谢您的阅读！