Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

官网文档 Bug 确认 🔍 #55585

Closed
sunzhongkai588 opened this issue Jul 18, 2023 · 4 comments
Closed

官网文档 Bug 确认 🔍 #55585

sunzhongkai588 opened this issue Jul 18, 2023 · 4 comments
Assignees

Comments

@sunzhongkai588
Copy link
Contributor

sunzhongkai588 commented Jul 18, 2023

一、 为什么做这件事?

研发同学总会说 ”这不是个 bug ,它只是一个 feature ”。但是对于官网的文档来说,如果发现了一个 bug,那大概率就是个 bug。
基于这个前提下,官网在年初上线了「文档反馈」的功能按钮,能够比较便捷的反馈官网文档 bug。用户只需要选取有问题的文档片段,并填写相应信息,便能直接向后台反馈文档存在的问题。

image

然而,由于一些内部原因,这些用户反馈的 bug 一直迟迟未得到确认,更无从谈起修复 😢。因此,我们希望借助各位社区开发者的力量,来帮助我们确认用户反馈的 bug。

二、 用户反馈的 Bug 在哪?

我们提供了用户反馈清单,包含了从功能上线到现在的用户反馈的bug。其中,清单有如下字段:

文档链接 文档版本 错误的文本片段 错误类型 错误描述 createTime
  • 【文档链接】 用户反馈有问题的文档,其相应的网址链接;
  • 【文档版本】 用户反馈有问题的文档,其所处的版本(在界面左上角);
image
  • 【错误的文本片段】 用户反馈有问题的文档下,具体某处存在错误的文本片段;
  • 【错误类型】 有4种错误类型:描述不清楚、内容错误、代码/图片/链接缺失、其他。按字面意思理解即可;
  • 【错误描述】 用户关于文档错误的补充说明;
  • 【createTime】 用户反馈文档问题的时间点。

三、 你需要做什么?

在上述的用户反馈清单中,你可以随意选取任意数量的用户反馈,并填如下字段:

develop分支是否存在该问题 reviewer
  • 【develop分支是否存在该问题】 由于官网文档每天都在更新优化,你需要确认在最新的版本(develop / master)中是否还存在用户所反馈的问题,这涉及到以下2点:
     1. 用户反馈的问题是否 在 develop/master 分支已被修复?
     2. 用户反馈的问题是否 真实存在,且确实是个bug?

    ❗️如果有不确定的情况,可以不填。
  • 【reviewer】 确认后填写你的 Github ID,方便我们后续统计。

四、 谁适合做这个任务?

  • 刚接触 paddle,想以此为契机参与飞桨社区活动的开发者们。
  • 啥也不会,但仍想为飞桨社区做贡献的新人小白们。
  • 对bug充满热情(误

五、 Leaderboard

截止8月9日榜单

GitHub ID review问题数量
@enkilee 125
@Liyulingyue 118
@ooooo-create 80
@yuchen202 45
@gouzil 17
@whisky-12 14
@Kaedeharai 8
@goh 4

后续,我们计划逐步开放文档的一系列开源活动,敬请期待~如果对文档感兴趣,可以扫码加群。

image
@sunzhongkai588 sunzhongkai588 changed the title 官网文档 Bug 确认 🔍(撰写中) 官网文档 Bug 确认 🔍 Jul 19, 2023
@sunzhongkai588 sunzhongkai588 pinned this issue Jul 20, 2023
@sunzhongkai588 sunzhongkai588 transferred this issue from PaddlePaddle/docs Jul 20, 2023
@Ligoml Ligoml pinned this issue Jul 20, 2023
@yuchen202
Copy link
Contributor

yuchen202 commented Jul 24, 2023 via email

@A1exan10er
Copy link

您好,加群二维码过期了,是否可更新一下呢?

@sunzhongkai588
Copy link
Contributor Author

您好,加群二维码过期了,是否可更新一下呢?

已更新~

@sunzhongkai588
Copy link
Contributor Author

感谢 @enkilee @Liyulingyue @ooooo-create @yuchen202 @gouzil @whisky-12 @Kaedeharai @goh 的开源贡献~ 🎉本活动已正式结项

这些确认过的bug,我再次review后会以任务形式发布~再次感谢以上同学的付出

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

4 participants