OB 社区提问指南

简介

OceanBase 社区是由OB开源生态所有参与者共同打造的社区,在这里您可以公开讨论各种技术问题。您可以关注热点话题或创建新话题,由热心的用户和 OceanBase 开源工程师为您做出解答。

当您提出一个技术问题时,能否得到有用的回答,往往取决于提问者的提问方式。本指南将指导您如何在 OceanBase 社区正确的提问以获得满意的答案。

欢迎您在社区平等的交流,也欢迎您在社区提出改进意见,帮助我们更好的完善服务。

在提问之前

在您要准备发帖提问之前,请您先尝试通过各种手段搜索答案避免重复提问,包括但不限于:

当你提问时

OceanBase 社区提问相关概念

  • 新建的问题称为话题,新话题下回复的内容为帖子。

  • 一个话题存在类别标签概念,创建话题时必须选择话题的类别,话题仅能属于一个类别,但是可以附加多个标签。

  • 类别非常重要,请您避免在错误类别中提问,社区所有类别的相关分类标准,请点击所有类别查看。此处仅做罗列:

    • OB新人必读
    • OB
    • 应用开发者专区
    • 社区活动
    • 培训中心
    • 建议与反馈
    • OB Cloud
    • 图数据库
    • 时序数据库
    • 专栏投稿
    • 灌水乐园
    • 训练营
  • 标签非常重要,在 OceanBase 社区中所有的OB组件都作为标签存在,用于标识话题所属的具体组件和具体问题,您在创建问题时,请通过选择或搜索标签的形式为问题追加标签。
    例如 OB 内核以及 OB 其他组件的问题统一归属于 OB 类别,当用户提问 OCP 组件的安装部署问题时,正确的分类与标签应该是:在新建话题中分类选择 OB标签选择 ocp 与 安装部署两个标签。

使用有意义且描述明确的标题

一个合适的标题,可以用一句话概括您遇到的问题。

:+1:Good

:-1:No Good

  • OCP报错
  • OBCP 考试
  • OB proxy问题

撰写简洁清晰的正文

请使用易读的文件格式描述问题

  • 不要 用截图来展示代码,正文支持 markdown 格式,使用三个 ` (标准键盘上 1 左边的那个键)来格式化代码,可以贴出整齐、易于理解的代码。
  • 如果您的问题篇幅很长,请简化问题,或正文分段。

请精确的描述问题

  • 清楚明确的表达你的问题以及需求,说明与预期不符合的现象
  • 描述问题发生的环境(OB或组件版本号,使用环境,相关操作等)
  • 提供一个重现问题的完整步骤,包括但不限于:
1、问题前后相关操作 
2、问题相关代码
3、错误日志及堆栈
  • 描述在提问前为确定问题而采取了哪些排查步骤,有哪些结论

社区发帖注意事项

  • 同一个问题避免多次创建新主题,选择一个分类发帖一次即可
  • 不要回复与当前主题不相关问题,如果有其他问题可以创建新主题
  • 直接截图而不配说明可能会得不到回复或得不到预期的回复

如果发帖后问题很快被自己解决了,当然最好和大家分享一下您的解决方案。

请注意礼貌,不要使用过激的言语,使用更温和一点的语气会发现世界很美好。

Tips:

  • 如果问题已经被解决,请你用:white_check_mark:标记为对我有用,这表示问题已被解决,方便其他用户搜索问题。
  • 请避免回复“+1”,而使用点赞:heart:,来表示你对内容的肯定。
  • 你非常喜欢的内容可以收藏。
  • 提问和回答的编辑器支持 markdown 语法,编辑器右边空白处是 md 文本的预览区。
  • 如果你遇到了不合适的内容,请你不要恢复,而是通过(:triangular_flag_on_post:图标)举报它。我们会有管理员处理。
  • 欢迎您在偏好设置中设置自己的头像。
12 个赞