兹拉坦
#5
参与进阶教程共建的方法
方法一:在社区论坛投稿
可以通过在 “建议与反馈 —— 文档&教程优化需求” 板块发帖进行投稿。
- 标题:【OceanBase DBA 进阶教程投稿】XXXXX
- 板块:建议与反馈 文档&教程优化需求
- 内容:包括但不限于问题分析排查记录、周边工具使用技巧、性能调优技巧等运维经验。
投稿后可手动在这个帖子下方艾特兹拉坦进行通知,或者私聊兹拉坦。
17 个赞
兹拉坦
#6
方法二:在社区博客投稿
还可以通过在社区博客中发文进行投稿。
- 标题:【OceanBase DBA 进阶教程投稿】XXXXX
- 内容:包括但不限于问题分析排查记录、周边工具使用技巧、性能调优技巧等运维经验。
- 标签:添加 “进阶教程投稿” 标签。
发布内容后,可以到社区论坛给这个叫兹拉坦的用户发送私信消息,催促他来对你的内容进行审核。
18 个赞
兹拉坦
#7
方法三:在 github 上提交内容
这种共建的方式,需要用户对 git 的使用有一些基础的了解。
需要大家有一个 github 的账号,并已经对你的开发环境进行过了配置。git 教程详见这里,本文不再详细赘述。
当然,在 github 上,提交内容远不止下文提及的通过命令行这一种方式,通过其他任何方式提交你的改动都是可以的。例如在 fork 仓库之后,直接在白屏页面通过 Add file、Contribute 等方式提交,可能会更符合部分用户的习惯。
步骤一
fork 项目,并添加上游仓库。
git clone https://github.com/your_name/oceanbase.github.io.git
cd oceanbase.github.io
# 添加上游仓库
git remote add upstream https://github.com/oceanbase/oceanbase.github.io.git
# 创建并切换新分支
git checkout -b your_branch_name
# 从远程仓库获取更新
git fetch upstream
步骤二
更新进阶教程的内容,并进行提交。
-
文档内容在 oceanbase.github.io/docs/user_manual/operation_and_maintenance/zh-CN/user_practice_co-construction/
路径下(可参考已有内容进行添加)。例如:01_introduction.md。
-
图片内容在 oceanbase.github.io/static/img/user_manual/operation_and_maintenance/zh-CN/user_practice_co-construction/
路径下(可参考已有内容进行添加)。例如:01_introduction/001.png。
-
如需增加新的大章节,则需要修改这个文件 oceanbase.github.io/sidebars.ts
(可参考已有内容进行添加)。
-
过程中需要参考这个项目的 README 进行展示效果的测试,安装 yarn 之后,可以通过执行 yarn start && yarn build
来查看你提交的内容对应的网页渲染效果(这里可以在 .zshrc 或者 .bashrc 等文件中设置一个更简化的命令别名,例如 alias see='yarn start && yarn build'
)。
-
确认网页的渲染效果符合预期之后,执行以下命令序列,把你在本地的修改推送到远程仓库:
git add .
git commit -m "message of your content"
git fetch upstream
git merge upstream/master
# 这里可能需要解决冲突
git push origin your_branch_name
- 然后到 github 上通过 pull request 提交你的修改即可。
- 最后 reviewer 可以选 liboyang0730 这个人,并点击 request 催促他来 review 及合并你的内容(如果这个人很懒,没能及时 review 你的内容,还可以到社区论坛给一个叫兹拉坦的用户发送私信消息,继续催促他来 review)。
步骤三
- 确认提交合并到主仓库之后,先手动 sync fork 一下 master 分支和你自己的分支。
- 然后到你自己分支下执行
git fetch upstream
和 git merge upstream/master
拉取上游主分支的最新内容。
- 最后重复步骤二,即可继续提交新内容。
19 个赞
兹拉坦
#8
方法四:教程捉虫
可以通过在 “建议与反馈 —— 文档&教程优化需求” 板块发帖进行捉虫。
- 标题:【OceanBase DBA 进阶教程捉虫】XXXXX
- 板块:建议与反馈 文档&教程优化需求
17 个赞
兹拉坦
#12
同时欢迎大家在本帖中提出你对这个共建计划的建议,以及更有趣的共建想法~
19 个赞
兹拉坦
#14
23 个赞
兹拉坦
#16
2025-01-07 15:07:20,在活动刚刚正式发起还不到一天的时候,@甯空 老师通过社区博客发起了第一篇共建投稿《负载均衡终极解决方案》!
@甯空 老师的这篇博客《负载均衡终极解决方案》,利用企业的实践经验,为我们弥补了进阶教程中容灾设计章节缺失的与负载 VIP 相关的内容,欢迎大家阅读!
这篇博客也即将被收入到进阶教程中的对应章节(可能会有补充和调整)。
值得纪念的时刻,值得纪念的内容,值得纪念的用户,真是值得纪念呀!
14 个赞
兹拉坦
#17
请 @甯空 老师有空儿的时候在 进阶教程共建投稿《负载均衡终极解决方案》积分发放贴 中领取一下 1000 积分的奖励~
15 个赞
兹拉坦
#25
如果动机只是单纯技术交流的话,麻烦 @Amber_Moe @洪波 @刘彻 一起帮忙看看用户的需求?
8 个赞