openedx / openedx/frontend-plugin-framework
Doc: Create file to track minor ways to customize Plugin Slot
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 13
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
There are some ways to customize a Plugin Slot configuration that add further flexibility to how a Plugin Slot renders its contents, and we want to make sure they’re kept track of so any developer can know how they can be used.
h4. Acceptance Criteria:
Create a file in the /docs directory of FPF that points out ways to customize a Plugin or the PluginSlot
aspluginPropsready(for iFrame Plugin)ErrorFallback(for iFrame Plugin)- any other nuances
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.
Research direction
Review the existing documentation in the /docs directory, then search the FPF code and usage examples for Plugin and PluginSlot customization. Create a documentation file covering as, pluginProps, ready, ErrorFallback, and other relevant nuances, with enough explanation for developers to use them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100