old and incomplete docs
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
先查看 issue 中链接的 XBlock Runtime API 页面和 xblock-tutorial 页面，然后将其与较旧的 Runtime XBlock API 参考文档和 cookiecutter-xblock 仓库进行比较。在编辑前确定文档范围：runtime 服务、基于 cookiecutter 的设置、needs 和 wants 装饰器，以及任何 Tutor 安装指南。选定的主题已记录在相关教程或参考页面中，即表示完成。
由索引模型根据 Issue 内容生成。
描述
XBlocks are the heart of Open edX. Yet, somehow the documentation around it is not complete.
There are a lot of places that are referenced for future fixes or mentioned TODO. like:
- There's no information about Runtime services.
https://docs.openedx.org/projects/xblock/en/latest/runtime.html#xblock.runtime.Runtime.service
I found this in Jira but it's quite old: https://openedx.atlassian.net/wiki/spaces/AC/pages/161400730/Open+edX+Runtime+XBlock+API - https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/introduction.html#other-open-edx-resources
You, the user community, can help update and revise this documentation project on GitHub.
- Nowhere inside the docs is mentioned about cookiecutter-xblock, but I think that's the standard approach to start with xblocks.
https://edx.readthedocs.io/projects/xblock/en/latest/xblock-tutorial/getting_started/ - No reference to
needsandwantsdecorators. (I know we can find the class method description https://edx.readthedocs.io/projects/xblock/en/latest/xblock.html#xblock.core.XBlock.needs but it's not clear for someone who's trying to develop an XBlock)
PS. We can add a tutor approach for installing xblocks as well.
@openedx/axim-engineering
- 主要语言
- Python
- 星标
- 471
- 派生
- 231
- 平均合并
- 2 天 20 小时
- 30 天内合并 PR
- 9
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
openedx/XBlock 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 72/100
-
performance
难度 5/5 一周以上 新手友好度 35/100
-
难度 2/5 1-3 小时 新手友好度 45/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
[DEPR]: Support for XBlock Runtimes with raw string scope IDs可能已有人在做 @salman2013 于 220 天前认领。 未关闭depr
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
sierra-research/tau2-bench#635 ·
维护者通常 1 天内回复
-
The add-ssm-model skill requires a Cython simulator; the contributing guide allows Python ones可能已有人在做 @fmuia 今天认领。 未关闭documentation skill
难度 2/5 1-3 小时 新手友好度 83/100
lnccbrown/ssm-simulators#406 ·
维护者通常 4 天内回复
-
难度 1/5 1 小时以内 新手友好度 95/100
btclib-org/btclib-ecc#309 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
jbacalso24/mimry#459 · 1 条评论 ·
维护者通常 1 天内回复
-
auth bug high-priority
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复