old and incomplete docs
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với trang XBlock Runtime API và các trang xblock-tutorial được liên kết trong issue, sau đó so sánh chúng với tài liệu tham khảo Runtime XBlock API cũ hơn và repository cookiecutter-xblock. Xác định phạm vi tài liệu trước khi chỉnh sửa: các dịch vụ runtime, thiết lập dựa trên cookiecutter, các decorator needs và wants, cùng mọi hướng dẫn cài đặt Tutor. Công việc được xem là hoàn tất khi các chủ đề đã chọn được ghi lại trong các trang tutorial hoặc reference phù hợp.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- Python
- Star
- 470
- Fork
- 231
- Merge trung bình
- 2 ngày 14 giờ
- Pull request đã merge (30 ngày)
- 7
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của openedx/XBlock
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
-
performance
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
[DEPR]: Support for XBlock Runtimes with raw string scope IDsCó thể đã có người làm @salman2013 đã nhận 211 ngày trước. Đang mởdepr
openedx/XBlock#784 · 10 bình luận · 3 reaction · 1 người được giao ·
Tất cả issue của openedx/XBlock
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
UKGovernmentBEIS/inspect_ai#5781 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Bump .cicd to wamp-cicd 4c2f9ac: `just land` refuses open A18 decisions, `just where` lists themĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
crossbario/cfxdb#139 ·
-
Bump .cicd to wamp-cicd 4c2f9ac: `just land` refuses open A18 decisions, `just where` lists themĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 84/100
crossbario/txaio#241 ·
-
UX
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
mediajunkie/piper-morgan-product#1963 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100