文档仓库
openGemini的文档仓库是：
文档目录介绍
中文文档路径
openGemini.github.io/src/zh/guide
英文文档路径
openGemini.github.io/src/guide
目录解析（中英文一致）
| 目录名称 | 说明 |
|---|---|
| introduction | 介绍 |
| quick_start | 快速上手 |
| write_data | 写数据 |
| query_data | 查询数据 |
| schema | 元数据 |
| develop | 应用开发 |
| features | 关键特性 |
| functions | 系统函数 |
| security_user | 用户与安全 |
| data_migrate | 数据迁移 |
| maintenance | 数据库运维 |
| kernel | 技术内幕 |
| contribution | 参与社区 |
| reference | 参考指南 |
| versions | 版本发布历史 |
| troubleshoot | 常见问题 |
图片保存目录
openGemini.github.io/static
参与贡献
下载源码
> git clone https://github.com/openGemini/openGemini.github.io.git
编译(非必须，编译的目的是要在本地查看文档效果）
参考仓库README 简单来讲分为三步：
-
安装node.js,推荐最新LTS版本
-
安装pnpm，版本推荐 v8.6.11
-
安装依赖 pnpm install --frozen-lockfile或pnpm install --nofrozen-lockfile
-
本地运行pnpm docs:dev，浏览器访问http://localhost:808
运行成功示例
~$ pnpm docs:dev
> openGemini docs@1.0.0 docs:dev /home/opengemini-1/Documents/openGemini.github.io> vuepress dev src
VuePress version mismatch: @vuepress/plugin-register-components is using 2.0.0-beta.66 while the main VuePress is using 2.0.0-beta.61✔ Initializing and preparing data - done in 1.15s
vite v4.1.4 dev server running at:
➜ Local: http://localhost:8080/ ➜ Network: http://192.168.0.14:8080/
文档开发
以开发openGemini函数功能的中文文档为例
- 进入functions目录
- 了解文件格式，打开任何一个MarkDown文件，例如：aggregate.md，格式如下：
---title: 聚合函数order: 1---
内容略...
title: 表示在文档标题，会在官网文档左侧导航栏上显示
order: 文档的顺序，为1表示排最前面，2表示排第二位，以此类推
其余部分: 文档内容, 按markdown格式编写
markdown语法参考
3.增加或在修改文档内容，保存
4.浏览器查看实际效果
文档提交
Git提交命令
> git add *> git commit -s -m "chore: update aggregate.md"> git push HEAD:newbranch
提交PR略
文档合并
提交PR后，后台自动会进行格式验证和项目构建，成功后便可合入，这时可以在PR下方留言：@committer，请求检视和合入。
可@任意一个我们的账号：
| xiangyu5632 | shilinlee |
|---|
好啦！以上就是openGemini社区【文档贡献】教程~文字虽多，实操起来其实就几个步骤，大家可以尝试一下，一定比你想象中简单，祝你在学习的过程中收获多多，成就满满！
openGemini 官网：www.openGemini.org
openGemini 开源地址：github.com/openGemini
openGemini 公众号：
欢迎关注～ 诚邀你加入 openGemini 社区，共建、共治、共享未来！
