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

【Docathon】文档 Bug 修复入门赛(新手向) #6187

Open
sunzhongkai588 opened this issue Sep 13, 2023 · 11 comments
Open

【Docathon】文档 Bug 修复入门赛(新手向) #6187

sunzhongkai588 opened this issue Sep 13, 2023 · 11 comments
Assignees
Labels
HappyOpenSource 快乐开源活动issue与PR

Comments

@sunzhongkai588
Copy link
Collaborator

sunzhongkai588 commented Sep 13, 2023

背景 🧐

修复飞桨文档,是许多开发者参与飞桨开源活动的起点。通过修复飞桨文档并提交 PR的形式,你将熟悉为 Paddle 社区贡献代码的流程规范。
我们提供了文档(主要为API文档)相关的 Bug 清单,并以任务的形式发布。本任务十分简单,如果你刚接触飞桨,或者对文档活动怀有热情,欢迎认领该系列任务🥳。

文档 Bug 来源

  1. 文档评测」:我们曾组织社区开发者对高频浏览的 API 文档进行评测,并发现了许多文档问题需要进行修复,详见:「文档修复」(来源于文档评测) ✅已完成
  2. 官网文档 Bug 确认 🔍 Paddle#55585 」:飞桨官网为用户提供了【文档反馈】的渠道,我们联同社区开发者整理了一份用户通过该渠道反馈的文档问题,详见: 「文档修复」(来源于bug确认赛)

你可以在以上 2 个来源中,选择任意数量的有问题的文档,进行认领并提交 PR 修复。

⚠️ 请优先修复来源于「bug确认赛」的问题。
⚠️ 有些问题可能已经在任务过程中被修复,可在此 issue 中 @sunzhongkai588 进行说明。
⚠️ 中文文档在 docs 仓库下修改,英文文档在 Paddle 仓库对应的 API 源码中修改。

任务流程 🚩

  1. 在上述提供的表格

    1. 「文档修复」(来源于文档评测)
    2. 「文档修复」(来源于bug确认赛)

    中,「认领人」 一栏填写自己的 GitHub ID,同时在此 issue 中回复认领任务的渠道+序号,如 文档评测-NO.1Bug确认赛-NO.1

  2. 修复完问题并提交 PR 时,请注意 PR 描述的规范

    • PR 标题: [Docathon] Fix xxxxx API Docs
    • PR 内容:
    <!-- Demo: https://github.com/PaddlePaddle/Paddle/pull/24810 -->
    ### PR types
    <!-- One of [ New features | Bug fixes | Function optimization | Performance optimization | Breaking changes | Others ] -->
    Bug fixes
    
    ### PR changes
    <!-- One of [ OPs | APIs | Docs | Others ] -->
    Docs
    
    ### Description
    <!-- Describe what you’ve done -->
    
    Issue from:「文档评测」NO.1
    
    涉及到的 API 有:
    docs\api\paddle\io\DataLoader_cn.rst
    ...
    
    关联文档(如有):https://github.com/PaddlePaddle/Paddle/pull/xxxxx
    
    相关链接:
    https://github.com/PaddlePaddle/docs/issues/6187
    https://github.com/PaddlePaddle/docs/issues/6165
    
    @sunzhongkai588 
    
  3. 提交 PR 后,请先自行浏览文档的预览链接,如果预览中有显示不正常的地方,则需要继续修复。

  4. 修复完成后,请在相应的表格中填写 PR 链接,方便后续统计。

mentor:@sunzhongkai588

参考链接 📖

参考PR:<待填>

@sunzhongkai588 sunzhongkai588 changed the title 【Docathon】修复文档Bug 【Docathon】修复文档 Bug Sep 13, 2023
@sunzhongkai588 sunzhongkai588 changed the title 【Docathon】修复文档 Bug 【Docathon】文档 Bug 修复入门赛 Sep 13, 2023
@sunzhongkai588 sunzhongkai588 changed the title 【Docathon】文档 Bug 修复入门赛 【Docathon】文档 Bug 修复入门赛(新手向) Sep 14, 2023
@sunzhongkai588 sunzhongkai588 added the HappyOpenSource 快乐开源活动issue与PR label Sep 15, 2023
@yuchen202
Copy link
Contributor

文档评测-NO.7、NO.21、22、NO.24-29

@whisky-12
Copy link
Contributor

文档评测-NO.126、NO.129-133、NO.91 、NO.93

@yuchen202
Copy link
Contributor

文档修复NO.8,14,51,54,56,57,59

@yuchen202
Copy link
Contributor

文档修复NO.2,9,18,19,20,25,27,29等

@smile2game
Copy link

文档修复NO.1

@Turingg
Copy link
Contributor

Turingg commented Dec 20, 2023

文档评测-NO.31、NO.62、NO.91-92、NO.118,、NO.138

@yuchen202
Copy link
Contributor

yuchen202 commented Dec 20, 2023 via email

@yuchen202
Copy link
Contributor

「文档修复」(来源于bug确认赛)NO.36~40

@Mister-TT
Copy link
Contributor

文档评测-NO.114

@yuchen202
Copy link
Contributor

yuchen202 commented Apr 1, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

No branches or pull requests

7 participants
@Mister-TT @sunzhongkai588 @whisky-12 @smile2game @yuchen202 @Turingg and others