来一起更新OceanBase的产品说明书吧~

近期我们对 OceanBase 4.0.0 文档进行优化重构,上线了V4.0.0-preview 版本。在这一次的调整中,我们协同 OceanBase 数据库的资深 DBA 一起反复讨论和梳理出了用户使用 OceanBase 数据库的核心链路和场景,并对文档信息按照用户角色和内容类型做了分层处理。同时也对文档中心进行重磅升级,新增文档导览图。

为了给大家提供更好的文档使用体验,现诚邀大家一起来体验试用,快来参加 4.0 文档提升计划,告诉我们哪些好用,哪些还需要改进吧~

优质反馈,我们将赠送精美礼品和社区积分喔~更多内容:arrow_down:看吧:eyes:

活动介绍

活动时间: 2023 年 3 月 15 日 - 2023 年 4 月 15 日

活动范围: OceanBase V4.0.0-preview 版本

在活动期间,您可以对文档和文档中心提出您的问题,参与共建。

文档中的问题类型举例如下:

  • 提供文档架构建议

    • 文档放在这里不太合理
    • 文档没有覆盖到常用的场景
    • 文档里还缺了什么
  • 提出文档正确性问题

    • 技术原理描述不正确
    • 操作步骤不正确
    • 参数解释不正确
  • 提出规范性问题和低错

    • 错别字
    • 标点使用错误
    • 文档格式错乱等

此外,您还可以反馈文档中心的使用问题,如:

  • 搜索不准确
  • 不知道如何使用文档中心

参与方式

Part 1 :文档内容反馈

通过 github 提交 PR 或者 issue 反馈文档的修改建议和问题。

活动前准备

你需要拥有一个 Github 账号,具体操作参见 注册新 GitHub 帐户 - GitHub Docs

操作步骤

  1. 登录 OceanBase V4.0.0-preview 版本文档

  1. 进入具体文档页面,查看文档。如文档中存在问题,单击 编辑
  2. 进入 GitHub 页面,单击 Fork this repository ,将直接进入 md 文件编辑页面。
  3. 完成修改后,单击 Propose changes ,保存您的修改。
  4. 单击 Creat pull request ,提交 pr。

特别说明

  • 一次仅提交一个问题。不要将多个问题放在一次提交。

  • 同样的问题在不同文档出现,如果多次提交,只算一个问题。

  • 同一问题多人反馈,默认采纳提交时间最早的 pr。

  • 以下问题视为无效:

    • 问题无法定位
    • 问题无法复现
    • 问题非首次反馈
    • 问题不符合验收标准
    • 业务或产品建议类
    • 其他经内部审核判定无效的情况

激励

我们将根据大家提交的问题类型,进行积分排名,积分前五名的参与者将有机会获得如下礼品:

第一名:神秘盲盒大奖~:gift:

第二名:洛菲机械键盘:keyboard:

第三名:卫衣

第四名:Polo 衫

第五名:无线充

同时每个为我们提交 PR 和参与讨论的同学,也有机会获得抱枕、鼠标垫等 OB 周边~

积分规则:

  • 文档架构建议:每个问题积 150 分
  • 文档正确性问题:每个问题积 100 分
  • 文档规范性问题和低错:每个问题积 10 分

Part 2: 参与文档讨论

同时,我们在社区问答区创建了文档中心改版讨论贴,您可以在评论中发起讨论或者参与大家发起的讨论,和大家一起碰撞数据库文档建设。

我们会将在活动结束后,选出最佳创意奖。获奖者将有机会获得神秘盲盒大奖~:gift:。同时每个参与讨论的同学,也有机会获得 OB 周边~

参加活动请入群

想要参加活动的朋友们,墙裂建议加入我们文档贡献社区交流群:41203246,届时我们将在群里互动答疑,同步活动积分和最终结果,为您解决活动中遇到的各种问题:tada:

钉钉群号: 41203246

赞,这活动不错 :pleading_face:

1 个赞

欢迎大家一起参加,共建属于你的产品说明书 :clap: :clap: :clap:


这里是刷新记录吧?刷新测试是啥意思

  1. 建议文档里加上所有隐藏参数的详细说明。
    比如__min_full_resource_pool_memory类似的相关参数,好多都不知道什么意思

  2. 建议文档里用到各种变量和参数是,设置好超链接,点击能直接查看该参数的说明

  3. 建议点击参数变量的链接,以弹出小窗口的形式展现,这样就不用去后退,或者看完后去浏览器关闭打开的标签了

接上一条:
4. 建议 __开头的内部表的说明也放到文档的说明中去

感谢您的反馈,我们尽快处理~:rose: