add example for installing FPF plugin components that aren't published to NPM
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the README slot examples and the build-contexts approach referenced from openedx-ai-extensions/tutor/openedx_ai_extensions/plugin.py at line 32. Document an example showing how to use FPF slots when frontend code is not published to NPM, and ensure the example reflects the existing build-contexts solution.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 1
- Forks
- 4
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 8
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openedx/sample-plugin
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
openedx/sample-plugin#46 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
openedx/sample-plugin#65 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 56/100
openedx/sample-plugin#51 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
openedx/sample-plugin#50 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
openedx/sample-plugin#33 ·
All issues in openedx/sample-plugin
Similar issues
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
[Feature] 奇物选择添加优先级 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
syfoud/Simulated_Scepter#174 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Giskard-AI/giskard-oss#2840 · 1 comment ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Openarea: repo bug perceived difficulty: 2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·