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

「Paddle Docathon」 文档系列活动 📃 #6165

Open
sunzhongkai588 opened this issue Sep 5, 2023 · 0 comments
Open

「Paddle Docathon」 文档系列活动 📃 #6165

sunzhongkai588 opened this issue Sep 5, 2023 · 0 comments
Assignees
Labels
good first issue Good for newcomers HappyOpenSource 快乐开源活动issue与PR

Comments

@sunzhongkai588
Copy link
Collaborator

sunzhongkai588 commented Sep 5, 2023

嗨👋!热衷挑战的你,准备好迎接一场前所未有的 Paddle Docathon 系列活动了吗💪?这可不是普通的开发任务,而是一个专门为文档改进而设计、充满社区欢乐的盛会哦!

背景

文档就像是技术的门面,它决定着开发者是否愿意走进并了解你的项目。因此,Paddle 在 官网 提供了完善的中英文文档内容。

  1. 「API英文文档」 存放在 PaddlePaddle/Paddle 仓库下的各个 API 的源码中
  2. 其他内容 则放在 PaddlePaddle/docs 仓库下。

我们希望通过这次活动,让 Paddle 的文档更加友好、易于理解,使更多人能够轻松上手、愉快使用!同时,通过改进文档,让开发者更流畅地使用 Paddle,更有效地掌握其功能,并以此为契机接触 Paddle 开发活动,从而促进机器学习领域的研究和应用。

⚠️ 注意: 本活动需要修改的文档,均为 develop 分支的内容。⚠️

为什么要参与?

1. 低门槛的开发活动

许多开源项目的活动,在参与之前常常要求开发者对代码库有深入了解。但别担心,我们的 Docathon 欢迎完全新手的加入 👏!你只需熟悉 Python,了解基本的 Git 和深度学习知识即可参与。

2. 实时可见的成果

Docathon 最棒的一点是,你可以实时看到你的贡献成果🤩。我们提供了可预览的工具(当然了,预览可能需要花40 分钟构建),让你能够亲眼见证文档的改进,这将成为你持续贡献的巨大动力。

  • 中文文档预览链接: http://preview-paddle-pr-XXXXX.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/en/api/paddle/abs_en.html

  • 英文文文档预览链接: http://preview-paddle-pr-XXXXXX.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/paddle/abs_cn.html

    ⚠️ 其中 XXXXX 为 PR 号。
    ⚠️ 文档预览链接需要等文档 CI 跑完之后才生效。中文文档 CI 为 Docs-New,英文文档 CI 为
    PR-CI-Paddle-Doc-Preview

3. 积极的开源合作氛围

Docathon 是一个协作性的开源活动,这意味着你将有机会与其他有趣的贡献者、维护者一起交流并改进文档 🤝。这是一个相互学习、分享想法的绝佳机会,同时我们还提供了“文档摸鱼群”,让大家轻松沟通~

🆕Discord 交流组:https://discord.gg/QqRXqb7Wun

4. 珍贵的学习机会

最后,即使你不是 Paddle 的资深开发者,Docathon也可以是一次很好的学习机会。你将有机会探索 Paddle 的各个模块,在你的电脑和 CI 中测试各种案例。你还能够学习如何通过「开源」的方式推动项目前进~

Paddle 社区的许多开发者,都是从参与「文档活动」开始,逐步成长为资深专家(有些甚至成为了我们的同事😄)~希望这将成为你开启Paddle开发探索之旅的第一站✨

🔥活动任务总览(持续更新ing)

基础任务:

任务名称 补充说明 链接 mentor
文档 bug 修复入门赛(新手向) 可能是你的第一个PR #6187 @sunzhongkai588

稍微难一丢丢的任务🤏:

任务名称 补充说明 链接 mentor
为 Tensor API 文档增加图例 可以使用 LLM 来写绘图代码哦 #6614 @sunzhongkai588
🆕 为公开 API 标注类型提示信息 学习 Python 的类型提示! PaddlePaddle/Paddle#65008 @megemini

开放任务:

任务名称 补充说明 链接 mentor
【Docs 重构计划】重新定义理想的文档 ✨ 一起来重构! #6420 @sunzhongkai588
🆕【飞桨开源社区博客】 Feature Request 一些博客前端页面的建设(孙师傅夹带私货) PFCCLab/blog#46 PFCCLab/blog#47 @sunzhongkai588

即将发布:

已结项任务:

任务名称 链接 mentor
补充 Overview 文档相关 API 描述✅ #6427 @Turingg
清理未暴露在 sphinx toctree 下的文档✅ #6491 @ooooo-create
中文文档缺失补充✅ #6193 @sunzhongkai588
中文文档示例代码清理(COPY-FROM ) ✅ #6300 @ooooo-create
英文文档格式修复(System Message)✅ PaddlePaddle/Paddle#58237 @sunzhongkai588
文档中的英文 api_label 修改✅ PaddlePaddle/Paddle#57363 @ooooo-create @sunzhongkai588
官网文档 bug 确认赛 ✅ PaddlePaddle/Paddle#55585 @sunzhongkai588
替换文档中的 tests/unittests 单测路径为新路径 ✅ #6140 @SigureMo
xdoctest剩余任务 ✅ PaddlePaddle/Paddle#55629 @megemini
docs 代码风格检查升级 ✅ #6158 #6242 @SigureMo
中文 api_label 修改系列任务 ✅ 任务说明: #6170 Motivation:#6142 @ooooo-create
templatedoc 机制清理 ✅ PaddlePaddle/Paddle#63734 @SigureMo

一些零散的结项任务

活动奖励

本次活动的成果奖励计入在「快乐开源」奖励下。

@sunzhongkai588 sunzhongkai588 added the HappyOpenSource 快乐开源活动issue与PR label Sep 15, 2023
@sunzhongkai588 sunzhongkai588 changed the title 「Paddle Docathon」 文档系列活动 📃(编辑中) 「Paddle Docathon」 文档系列活动 📃 Sep 18, 2023
@sunzhongkai588 sunzhongkai588 self-assigned this Sep 18, 2023
@sunzhongkai588 sunzhongkai588 pinned this issue Sep 18, 2023
@sunzhongkai588 sunzhongkai588 added the good first issue Good for newcomers label Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers HappyOpenSource 快乐开源活动issue与PR
Projects
Status: In Progress
Development

No branches or pull requests

1 participant