openedx / openedx/sample-plugin

add example for installing FPF plugin components that aren't published to NPM

Aperta
#12 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
1
Fork
4
Merge medio
3g 1h
PR unite (30g)
8

Descrizione

I had a conversation with Felipe where he asked:

Do you know of any tutor plugin that loads the code of a UIslot without requiring that the code is first published to NPM?

I didn't know any examples. The README examples for the slots all use inline RenderWidget code, and the other examples use NPM packages.

The solution used for openedx-ai-extensions ended up being Tutor's build-contexts.

https://github.com/openedx/openedx-ai-extensions/blob/main/tutor/openedx_ai_extensions/plugin.py#L32


I definitely think "make a plugin that utilizes FPF slots but doesn't have frontend code published to NPM" is a reasonable use case that we should (and apparently already do) support, so it'd be great to document that.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con gli esempi di slot nel README e con l’approccio build-contexts a cui si fa riferimento in openedx-ai-extensions/tutor/openedx_ai_extensions/plugin.py at line 32. Documenta un esempio che mostri come usare gli slot FPF quando il codice frontend non è pubblicato su NPM e assicurati che l’esempio rifletta la soluzione build-contexts esistente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
Mezza giornata
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.