openedx / openedx/docs.openedx.org
[Plug-in Developer] Quickstart
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
Write a Quick Start doc for plugin developers covering the basic, necessary steps to get started with developing plugins/set up a plugin dev environment in ~under 20 minutes.
What is a Quick Start? https://documentation.divio.com/tutorials/
Quick Start Template you can use as reference/inspiration: https://docs.openedx.org/en/latest/educators/quick_starts/build_a_course.html
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
Use the issue’s Divio Quick Start guidance and the linked Open edX template as references, then locate the existing plugin documentation and development-environment entry points. Done means a Quick Start for plugin developers that covers the necessary setup and basic steps and can be followed in about 20 minutes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100