old and incomplete docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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
- スター
- 470
- フォーク
- 231
- 平均マージ
- 2日 14時間
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openedx/XBlock のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
performance
難易度 5/5 1週間以上 初心者へのやさしさ 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 が 210 日前に担当しました。 オープンdepr
似ている issue
-
Link Checker Reportオープンautomated issue report
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
RapidAI/RapidOCRDocs#119 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
btclib-org/btclib-node#1833 ·
メンテナーはふだん 1 日以内に返信
-
IRIS reader: no-data velocity bins (DB_VEL, DB_VELC) returned as 0.0 m/s instead of NaN対応中かも @syedhamidali が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
elodin-sys/elodin#890 ·
メンテナーはふだん 1 日以内に返信