old and incomplete docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia dalla pagina XBlock Runtime API e dalle pagine di xblock-tutorial collegate nell'issue, quindi confrontale con il precedente riferimento Runtime XBlock API e il repository cookiecutter-xblock. Definisci l'ambito della documentazione prima di apportare modifiche: servizi runtime, configurazione basata su cookiecutter, decorator needs e wants ed eventuali indicazioni sull'installazione di Tutor. Il lavoro è completato quando gli argomenti selezionati sono documentati nelle pagine pertinenti del tutorial o del riferimento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 470
- Fork
- 231
- Merge medio
- 2g 14h
- PR unite (30g)
- 7
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openedx/XBlock
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
performance
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
[DEPR]: Support for XBlock Runtimes with raw string scope IDsForse già presa @salman2013 l’ha presa 210 giorni fa. Apertadepr
openedx/XBlock#784 · 10 commenti · 3 reazioni · 1 assegnatario ·
Tutte le issue di openedx/XBlock
Issue simili
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
epam/ai-dial-quickapps-backend#628 ·
I maintainer di solito rispondono entro 2 giorni
-
0xlau.dev 已失效，切换成 timlau.meAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 69/100
timqian/chinese-independent-blogs#2235 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
eclipse-score/coverage_tool#27 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
bojieli/ai-agent-book#1174 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
RedHatQE/mtv-api-tests#721 ·
I maintainer di solito rispondono entro 1 giorno